Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Document include_in_* nested mapping parms #52648

Merged
merged 3 commits into from
Feb 25, 2020
Merged

[DOCS] Document include_in_* nested mapping parms #52648

merged 3 commits into from
Feb 25, 2020

Conversation

jrodewig
Copy link
Contributor

Adds documentation for the include_in_parent and include_in_root
mapping parameters for the nested mapping datatype.

Closes #52309.

Adds documentation for the `include_in_parent` and `include_in_root`
mapping parameters for the `nested` mapping datatype.
@jrodewig jrodewig added >docs General docs changes :Search Foundations/Mapping Index mappings, including merging and defining field types labels Feb 21, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search (:Search/Mapping)

Copy link
Contributor

@jtibshirani jtibshirani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing this!


`include_in_parent`::
(Optional, boolean)
If `true`, inner objects are indexed as <<object,flat key-value pairs>> for the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, this description could be hard to understand. An alternate suggestion: "If true, all fields in the nested object are also added to the parent document as standard (flat) fields." A similar suggestion applies to include_in_root below.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the feedback @jtibshirani. I've reworded as suggested with 817c0ff.

@jrodewig jrodewig requested a review from jtibshirani February 23, 2020 15:46
Copy link
Contributor

@jtibshirani jtibshirani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.


`include_in_root`::
(Optional, boolean)
If `true`, all fields in the nested object are also added to the topmost
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small comment, maybe 'root document' would be a little clearer.

@jrodewig
Copy link
Contributor Author

Thanks @jtibshirani.

@jrodewig jrodewig merged commit 12ed6f1 into elastic:master Feb 25, 2020
@jrodewig jrodewig deleted the docs__nested-include-parms branch February 25, 2020 12:12
jrodewig added a commit that referenced this pull request Feb 25, 2020
Adds documentation for the `include_in_parent` and `include_in_root`
mapping parameters for the `nested` mapping datatype.
jrodewig added a commit that referenced this pull request Feb 25, 2020
Adds documentation for the `include_in_parent` and `include_in_root`
mapping parameters for the `nested` mapping datatype.
@jrodewig
Copy link
Contributor Author

Backport commits

master 12ed6f1
7.x 1a14ae4
7.6 7c88703

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search Foundations/Mapping Index mappings, including merging and defining field types v7.6.1 v7.7.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Mapping options include_in_root and include_in_parent are not documented
4 participants