Skip to content

Commit

Permalink
[DOCS] Add collapsible sections to 7.x breaking changes (#55334)
Browse files Browse the repository at this point in the history
Adds collapsible sections and new format to the 7.x breaking changes.

Relates to #53229.
  • Loading branch information
jrodewig authored Apr 22, 2020
1 parent 6f95139 commit 8d05d7d
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 32 deletions.
2 changes: 2 additions & 0 deletions docs/reference/mapping/types/nested.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -194,11 +194,13 @@ The fields within the nested object, which can be of any
<<mapping-types,datatype>>, including `nested`. New properties
may be added to an existing nested object.

[[nested-include-in-parent-parm]]
`include_in_parent`::
(Optional, boolean)
If `true`, all fields in the nested object are also added to the parent document
as standard (flat) fields. Defaults to `false`.

[[nested-include-in-root-parm]]
`include_in_root`::
(Optional, boolean)
If `true`, all fields in the nested object are also added to the root
Expand Down
97 changes: 65 additions & 32 deletions docs/reference/migration/migrate_7_8.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,58 +5,91 @@
++++

This section discusses the changes that you need to be aware of when migrating
your application to Elasticsearch 7.8.
your application to {es} 7.8.

See also <<release-highlights>> and <<es-release-notes>>.

coming[7.8.0]

* <<breaking_78_mappings_changes>>
* <<breaking_78_settings_changes>>

//NOTE: The notable-breaking-changes tagged regions are re-used in the
//Installation and Upgrade Guide

//tag::notable-breaking-changes[]

//end::notable-breaking-changes[]

[discrete]
[[breaking_78_api_changes]]
=== API changes

[discrete]
==== Deprecation of `local` parameter for get field mapping API

The `local` parameter is a no-op and field mappings are always retrieved locally.
As of 7.8, this parameter is deprecated and will be removed in next major version.

[discrete]
[[breaking_78_mappings_changes]]
=== Mappings changes

[discrete]
[[prevent-enabled-setting-change]]
==== `enabled` setting cannot be changed on root mapper

Previously, Elasticsearch accepted mapping updates that tried to change the
`enabled` setting on the root mapping. The update was not applied, but the
request didn't throw an error. As of 7.8, requests that attempt to change
`enabled` on the root mapping will fail.
.The `enabled` mapping parameter cannot be changed for a root mapping.
[%collapsible]
====
*Details* +
Mapping requests that attempt to change the {ref}/enabled.html[`enabled`]
mapping parameter for a root mapping will fail and return an error.
Previously, {es} accepted mapping requests that attempted to change the
`enabled` parameter of the root mapping. Theses changes were not applied, but
such requests didn't return an error.
*Impact* +
To avoid errors, do not submit mapping requests that change the
{ref}/enabled.html[`enabled`] mapping parameter.
====

[discrete]
[[prevent-include-in-root-change]]
==== `include_in_root` and `include_in_parent` cannot be changed

Elasticsearch previously accepted mapping updates that changed the
`include_in_root` and `include_in_parent` settings. The update was not
applied, but the request didn't throw an error. As of 7.8, requests that
attempt to change these settings will fail.
.The `include_in_parent` and `include_in_root` mapping parameters cannot be changed for `nested` fields.
[%collapsible]
====
*Details* +
Mapping requests that attempt to change the
{ref}/nested.html#nested-include-in-parent-parm[`include_in_parent`] or
{ref}/nested.html#nested-include-in-root-parm[`include_in_root`] mapping
parameter for a `nested` field will fail and return an error.
Previously, {es} accepted mapping requests that attempted to change the
`include_in_parent` or `include_in_root` parameter. Theses changes were not
applied, but such requests didn't return an error.
*Impact* +
To avoid errors, do not submit mapping requests that change the
{ref}/nested.html#nested-include-in-parent-parm[`include_in_parent`] or
{ref}/nested.html#nested-include-in-root-parm[`include_in_root`] mapping
parameter.
====

.The get field mapping API's `local` query parameter is deprecated.
[%collapsible]
====
*Details* +
The {ref}/indices-get-field-mapping.html[get field mapping API]'s `local` query
parameter is deprecated and will be removed in {es} 8.0.0.
The `local` parameter is a no-op. The API always retrieves field mappings
locally.
*Impact* +
To avoid deprecation warnings, discontinue use of the `local` parameter.
====

[discrete]
[[breaking_78_settings_changes]]
=== Settings changes

[discrete]
[[deprecate-node-local-storage]]
==== `node.local_storage` is deprecated

In Elasticsearch 7.8.0, the setting `node.local_storage` was deprecated and
beginning in Elasticsearch 8.0.0 all nodes will require local storage.
.The `node.local_storage` setting is deprecated.
[%collapsible]
====
*Details* +
The `node.local_storage` setting is deprecated. In {es} 8.0.0, all nodes require
local storage.
*Impact* +
To avoid deprecation warnings, discontinue use of the `node.local_storage`
setting.
====

//end::notable-breaking-changes[]

0 comments on commit 8d05d7d

Please sign in to comment.