[DOCS] Add documentation for Painless field API #83388
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lockewritesdocs
added
>docs
elasticmachine
added
Team:Core/Infra
Collaborator
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
Collaborator
|
Pinging @elastic/es-docs (Team:Docs) |
stu-elastic
reviewed
Feb 1, 2022
jdconrad
reviewed
Feb 1, 2022
Contributor
jdconrad
left a comment
jdconrad
left a comment
There was a problem hiding this comment.
This is a solid start! Left a few pieces of general feedback.
A couple other thoughts:
- We should probably specify this is a feature preview and is subject to change somewhere.
- Some fields do not yet work with the fields API such as text or geo since we are still trying to figure out the best values there to return, so continued use of
docthere is what is available. - Need to differentiate between fields that return primitive types versus reference types since null can't be used for primitive defaults.
stu-elastic
reviewed
Feb 1, 2022
stu-elastic
reviewed
Feb 1, 2022
stu-elastic
reviewed
Feb 1, 2022
stu-elastic
reviewed
Feb 1, 2022
Contributor
|
Let's avoid converting things to |
stu-elastic
reviewed
Feb 2, 2022
stu-elastic
reviewed
Feb 2, 2022
stu-elastic
reviewed
Feb 2, 2022
stu-elastic
reviewed
Feb 2, 2022
stu-elastic
reviewed
Feb 2, 2022
stu-elastic
reviewed
Feb 2, 2022
stu-elastic
reviewed
Feb 2, 2022
stu-elastic
reviewed
Feb 2, 2022
stu-elastic
reviewed
Feb 2, 2022
jdconrad
approved these changes
Feb 3, 2022
Contributor
jdconrad
left a comment
jdconrad
left a comment
There was a problem hiding this comment.
This looks pretty good! Left a few comments to be addressed still.
jdconrad
approved these changes
Feb 3, 2022
Contributor
jdconrad
left a comment
jdconrad
left a comment
There was a problem hiding this comment.
Table looks good to me! Thank you!
lockewritesdocs
pushed a commit
to lockewritesdocs/elasticsearch
that referenced
this pull request
Feb 3, 2022
* [DOCS] Add documentation for Painless field API * Moving content to a new page and incorporating reviewer feedback * Clarify note * Incorporating review comments * Remove Object so as not to confuse it with the object type * Add section and table for supported mapped field types * Update table based on review feedback
Collaborator
💚 Backport successful
|
elasticsearchmachine
pushed a commit
that referenced
this pull request
Feb 3, 2022
* [DOCS] Add documentation for Painless field API * Moving content to a new page and incorporating reviewer feedback * Clarify note * Incorporating review comments * Remove Object so as not to confuse it with the object type * Add section and table for supported mapped field types * Update table based on review feedback
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new section for accessing documents with the
fieldAPI and explains the benefits of using this API over the old method of accessing document values.Preview link: https://elasticsearch_83388.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/script-fields-api.html
Relates to #61388