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

Rename 'json' to 'embedded_json'. #40712

Merged
merged 1 commit into from
Apr 2, 2019

Conversation

jtibshirani
Copy link
Contributor

A concern around the name json is that because the entire document is JSON,
new users may see this field and think that they should always use it. We
thought that a more verbose name like embedded_json would help convey that the
field type has a special, non-obvious purpose.

This commit updates documentation references to embedded_json, but leaves the
JsonField naming in the code to avoid very long class names.

@jtibshirani jtibshirani added :Search Foundations/Mapping Index mappings, including merging and defining field types >refactoring labels Apr 2, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search

One concern around the name `json` is that because the entire document is JSON,
new users may see this field and think that they should always use it. We
thought that a more verbose name like `embedded_json` would help convey that the
field type has a special, non-obvious purpose.

This commit updates documentation references to `embedded_json`, but leaves the
`JsonField` naming in the code to avoid very long class names.
@jtibshirani
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/2
@elasticmachine run elasticsearch-ci/bwc

Copy link
Contributor

@jimczi jimczi left a comment

Choose a reason for hiding this comment

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

LGTM

@jtibshirani
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/2

@jtibshirani
Copy link
Contributor Author

Thanks @jimczi for the review.

@jtibshirani jtibshirani merged commit 6a0c377 into elastic:object-fields Apr 2, 2019
@jtibshirani jtibshirani deleted the json-field-naming branch April 2, 2019 20:11
jtibshirani added a commit that referenced this pull request Apr 10, 2019
One concern around the name `json` is that because the entire document is JSON,
new users may see this field and think that they should always use it. We
thought that a more verbose name like `embedded_json` would help convey that the
field type has a special, non-obvious purpose.

This commit updates documentation references to `embedded_json`, but leaves the
`JsonField` naming in the code to avoid very long class names.
jtibshirani added a commit that referenced this pull request Apr 17, 2019
One concern around the name `json` is that because the entire document is JSON,
new users may see this field and think that they should always use it. We
thought that a more verbose name like `embedded_json` would help convey that the
field type has a special, non-obvious purpose.

This commit updates documentation references to `embedded_json`, but leaves the
`JsonField` naming in the code to avoid very long class names.
jtibshirani added a commit that referenced this pull request May 1, 2019
One concern around the name `json` is that because the entire document is JSON,
new users may see this field and think that they should always use it. We
thought that a more verbose name like `embedded_json` would help convey that the
field type has a special, non-obvious purpose.

This commit updates documentation references to `embedded_json`, but leaves the
`JsonField` naming in the code to avoid very long class names.
jtibshirani added a commit that referenced this pull request May 24, 2019
One concern around the name `json` is that because the entire document is JSON,
new users may see this field and think that they should always use it. We
thought that a more verbose name like `embedded_json` would help convey that the
field type has a special, non-obvious purpose.

This commit updates documentation references to `embedded_json`, but leaves the
`JsonField` naming in the code to avoid very long class names.
jtibshirani added a commit that referenced this pull request May 29, 2019
One concern around the name `json` is that because the entire document is JSON,
new users may see this field and think that they should always use it. We
thought that a more verbose name like `embedded_json` would help convey that the
field type has a special, non-obvious purpose.

This commit updates documentation references to `embedded_json`, but leaves the
`JsonField` naming in the code to avoid very long class names.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>refactoring :Search Foundations/Mapping Index mappings, including merging and defining field types
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants