浏览代码

[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.
James Rodewig 5 年之前
父节点
当前提交
12ed6f12e9
共有 1 个文件被更改,包括 17 次插入9 次删除
  1. 17 9
      docs/reference/mapping/types/nested.asciidoc

+ 17 - 9
docs/reference/mapping/types/nested.asciidoc

@@ -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