Skip to content

Commit

Permalink
[DOCS] Document include_in_* nested mapping parms (#52648)
Browse files Browse the repository at this point in the history
Adds documentation for the `include_in_parent` and `include_in_root`
mapping parameters for the `nested` mapping datatype.
  • Loading branch information
jrodewig authored Feb 25, 2020
1 parent 2a95ecb commit 12ed6f1
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions docs/reference/mapping/types/nested.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -183,18 +183,26 @@ or <<request-body-search-stored-fields, `stored_fields`>>.

The following parameters are accepted by `nested` fields:

[horizontal]
<<dynamic,`dynamic`>>::

Whether or not new `properties` should be added dynamically to an existing
nested object. Accepts `true` (default), `false` and `strict`.
(Optional, string)
Whether or not new `properties` should be added dynamically to an existing
nested object. Accepts `true` (default), `false` and `strict`.

<<properties,`properties`>>::

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.

(Optional, object)
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.

`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`.

`include_in_root`::
(Optional, boolean)
If `true`, all fields in the nested object are also added to the root
document as standard (flat) fields. Defaults to `false`.

[float]
=== Limits on `nested` mappings and objects
Expand Down

0 comments on commit 12ed6f1

Please sign in to comment.