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

Added documentation on GeoJSON format for points and geo-points #86066

Merged
merged 2 commits into from
Apr 28, 2022

Conversation

craigtaverner
Copy link
Contributor

@craigtaverner craigtaverner commented Apr 21, 2022

Recent work added support for GeoJSON to the following field types:

This PR provides documentation for these. Since this is based on the branch for cartesian point, it includes the commit from that branch. If that PR is merged first, then this PR will only contain the documentation commit. In either case the intention is to review only the documentation commit in this PR.

@craigtaverner craigtaverner added >docs General docs changes :Analytics/Geo Indexing, search aggregations of geo points and shapes v8.3.0 labels Apr 21, 2022
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Apr 21, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-analytics-geo (Team:Analytics)

@craigtaverner craigtaverner force-pushed the geojson_point_docs branch 2 times, most recently from 653e73d to 46f2c6c Compare April 21, 2022 14:23
@iverase
Copy link
Contributor

iverase commented Apr 26, 2022

@craigtaverner maybe it would be good to update this branch to get reviewed?

@@ -77,8 +77,9 @@ sorted list of `double` values. See
<<painless-runtime-double,double_field context>>.

`geo_point_field`::
The context for {ref}/geo-point.html[`geo-point` fields]. `emit` takes a
`geo-point` value and the script returns coordinates for the geo point. See
The context for {ref}/geo-point.html[`geo-point` fields]. `emit` takes two double
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@iverase Could you verify this change. I think the old description seemed quite incorrect.

Copy link
Contributor

Choose a reason for hiding this comment

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

I had a look and yes the explanation of the emit is correct, thanks! What it is not clear to me what we refer here to what the script returns. This is currently a bug as it should behave as an indexed geo_point which is not the case.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, this geo_point context is different to the out put of the fields API. lThe change looks good to me then.

Copy link
Contributor

@iverase iverase left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Analytics/Geo Indexing, search aggregations of geo points and shapes >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v8.3.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants