Skip to content

Commit 12ed6f1

Browse files
authored
[DOCS] Document include_in_* nested mapping parms (#52648)
Adds documentation for the `include_in_parent` and `include_in_root` mapping parameters for the `nested` mapping datatype.
1 parent 2a95ecb commit 12ed6f1

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

docs/reference/mapping/types/nested.asciidoc

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -183,18 +183,26 @@ or <<request-body-search-stored-fields, `stored_fields`>>.
183183

184184
The following parameters are accepted by `nested` fields:
185185

186-
[horizontal]
187186
<<dynamic,`dynamic`>>::
188-
189-
Whether or not new `properties` should be added dynamically to an existing
190-
nested object. Accepts `true` (default), `false` and `strict`.
187+
(Optional, string)
188+
Whether or not new `properties` should be added dynamically to an existing
189+
nested object. Accepts `true` (default), `false` and `strict`.
191190

192191
<<properties,`properties`>>::
193-
194-
The fields within the nested object, which can be of any
195-
<<mapping-types,datatype>>, including `nested`. New properties
196-
may be added to an existing nested object.
197-
192+
(Optional, object)
193+
The fields within the nested object, which can be of any
194+
<<mapping-types,datatype>>, including `nested`. New properties
195+
may be added to an existing nested object.
196+
197+
`include_in_parent`::
198+
(Optional, boolean)
199+
If `true`, all fields in the nested object are also added to the parent document
200+
as standard (flat) fields. Defaults to `false`.
201+
202+
`include_in_root`::
203+
(Optional, boolean)
204+
If `true`, all fields in the nested object are also added to the root
205+
document as standard (flat) fields. Defaults to `false`.
198206

199207
[float]
200208
=== Limits on `nested` mappings and objects

0 commit comments

Comments
 (0)