From 8173b1cad43b7997b6924b6d47ef0136a89cb097 Mon Sep 17 00:00:00 2001 From: Abdon Pijpelink Date: Wed, 20 Jul 2022 12:47:35 +0200 Subject: [PATCH 1/2] [DOCS] Remove camel case variations. Closes #73417 --- docs/reference/query-dsl/geo-bounding-box-query.asciidoc | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/reference/query-dsl/geo-bounding-box-query.asciidoc b/docs/reference/query-dsl/geo-bounding-box-query.asciidoc index 1a9720c05530f..228dd8c7c4854 100644 --- a/docs/reference/query-dsl/geo-bounding-box-query.asciidoc +++ b/docs/reference/query-dsl/geo-bounding-box-query.asciidoc @@ -348,11 +348,9 @@ corner at `39.375,-67.5`. ==== Vertices The vertices of the bounding box can either be set by `top_left` and -`bottom_right` or by `top_right` and `bottom_left` parameters. More -over the names `topLeft`, `bottomRight`, `topRight` and `bottomLeft` -are supported. Instead of setting the values pairwise, one can use -the simple names `top`, `left`, `bottom` and `right` to set the -values separately. +`bottom_right` or by `top_right` and `bottom_left` parameters. Instead of +setting the values pairwise, one can use the simple names `top`, `left`, +`bottom` and `right` to set the values separately. [source,console] -------------------------------------------------- From 1f143b365a493df20d31f36ff2aa66b03b48bbd9 Mon Sep 17 00:00:00 2001 From: Abdon Pijpelink Date: Wed, 20 Jul 2022 16:19:27 +0200 Subject: [PATCH 2/2] [DOCS] Switch to sentence casing in titles --- .../query-dsl/geo-bounding-box-query.asciidoc | 18 +++++++++--------- .../query-dsl/geo-distance-query.asciidoc | 12 ++++++------ .../query-dsl/geo-polygon-query.asciidoc | 10 +++++----- .../query-dsl/geo-shape-query.asciidoc | 8 ++++---- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/reference/query-dsl/geo-bounding-box-query.asciidoc b/docs/reference/query-dsl/geo-bounding-box-query.asciidoc index 228dd8c7c4854..3fb6c11181a19 100644 --- a/docs/reference/query-dsl/geo-bounding-box-query.asciidoc +++ b/docs/reference/query-dsl/geo-bounding-box-query.asciidoc @@ -158,7 +158,7 @@ GET my_locations,my_geoshapes/_search -------------------------------------------------- [discrete] -==== Query Options +==== Query options [cols="<,<",options="header",] |======================================================================= @@ -173,13 +173,13 @@ accept geo points with invalid latitude or longitude, set to [[query-dsl-geo-bounding-box-query-accepted-formats]] [discrete] -==== Accepted Formats +==== Accepted formats In much the same way the `geo_point` type can accept different representations of the geo point, the filter can accept it as well: [discrete] -===== Lat Lon As Properties +===== Lat lon as properties [source,console] -------------------------------------------------- @@ -210,7 +210,7 @@ GET my_locations/_search -------------------------------------------------- [discrete] -===== Lat Lon As Array +===== Lat lon as array Format in `[lon, lat]`, note, the order of lon/lat here in order to conform with http://geojson.org/[GeoJSON]. @@ -238,7 +238,7 @@ GET my_locations/_search -------------------------------------------------- [discrete] -===== Lat Lon As String +===== Lat lon as string Format in `lat,lon`. @@ -265,7 +265,7 @@ GET my_locations/_search -------------------------------------------------- [discrete] -===== Bounding Box as Well-Known Text (WKT) +===== Bounding box as well-known text (WKT) [source,console] -------------------------------------------------- @@ -377,14 +377,14 @@ GET my_locations/_search -------------------------------------------------- [discrete] -==== Multi Location Per Document +==== Multi location per document The filter can work with multiple locations / points per document. Once a single location / point matches the filter, the document will be included in the filter [discrete] -==== Ignore Unmapped +==== Ignore unmapped When set to `true` the `ignore_unmapped` option will ignore an unmapped field and will not match any documents for this query. This can be useful when @@ -393,7 +393,7 @@ querying multiple indexes which might have different mappings. When set to is not mapped. [discrete] -==== Notes on Precision +==== Notes on precision Geopoints have limited precision and are always rounded down during index time. During the query time, upper boundaries of the bounding boxes are rounded down, diff --git a/docs/reference/query-dsl/geo-distance-query.asciidoc b/docs/reference/query-dsl/geo-distance-query.asciidoc index c87d185dd229c..5c1b0a1ecfc3f 100644 --- a/docs/reference/query-dsl/geo-distance-query.asciidoc +++ b/docs/reference/query-dsl/geo-distance-query.asciidoc @@ -146,13 +146,13 @@ GET my_locations,my_geoshapes/_search [discrete] -==== Accepted Formats +==== Accepted formats In much the same way the `geo_point` type can accept different representations of the geo point, the filter can accept it as well: [discrete] -===== Lat Lon As Properties +===== Lat lon as properties [source,console] -------------------------------------------------- @@ -178,7 +178,7 @@ GET /my_locations/_search -------------------------------------------------- [discrete] -===== Lat Lon As Array +===== Lat lon as array Format in `[lon, lat]`, note, the order of lon/lat here in order to conform with http://geojson.org/[GeoJSON]. @@ -205,7 +205,7 @@ GET /my_locations/_search [discrete] -===== Lat Lon As WKT String +===== Lat lon as WKT string Format in https://docs.opengeospatial.org/is/12-063r5/12-063r5.html[Well-Known Text]. @@ -280,14 +280,14 @@ The following are options allowed on the filter: coordinates (default is `STRICT`). [discrete] -==== Multi Location Per Document +==== Multi location per document The `geo_distance` filter can work with multiple locations / points per document. Once a single location / point matches the filter, the document will be included in the filter. [discrete] -==== Ignore Unmapped +==== Ignore unmapped When set to `true` the `ignore_unmapped` option will ignore an unmapped field and will not match any documents for this query. This can be useful when diff --git a/docs/reference/query-dsl/geo-polygon-query.asciidoc b/docs/reference/query-dsl/geo-polygon-query.asciidoc index 723e91e3bc6fb..c2f4f52c0c3f8 100644 --- a/docs/reference/query-dsl/geo-polygon-query.asciidoc +++ b/docs/reference/query-dsl/geo-polygon-query.asciidoc @@ -35,7 +35,7 @@ GET /_search // TEST[warning:Deprecated field [geo_polygon] used, replaced by [[geo_shape] query where polygons are defined in geojson or wkt]] [discrete] -==== Query Options +==== Query options [cols="<,<",options="header",] |======================================================================= @@ -48,10 +48,10 @@ or longitude, or `STRICT` (default is `STRICT`). |======================================================================= [discrete] -==== Allowed Formats +==== Allowed formats [discrete] -===== Lat Long as Array +===== Lat long as array Format as `[lon, lat]` @@ -85,7 +85,7 @@ GET /_search // TEST[warning:Deprecated field [geo_polygon] used, replaced by [[geo_shape] query where polygons are defined in geojson or wkt]] [discrete] -===== Lat Lon as String +===== Lat lon as string Format in `lat,lon`. @@ -151,7 +151,7 @@ The query *requires* the <> type to be set on the relevant field. [discrete] -==== Ignore Unmapped +==== Ignore unmapped When set to `true` the `ignore_unmapped` option will ignore an unmapped field and will not match any documents for this query. This can be useful when diff --git a/docs/reference/query-dsl/geo-shape-query.asciidoc b/docs/reference/query-dsl/geo-shape-query.asciidoc index 0ab731d1355fb..570a104a18480 100644 --- a/docs/reference/query-dsl/geo-shape-query.asciidoc +++ b/docs/reference/query-dsl/geo-shape-query.asciidoc @@ -21,7 +21,7 @@ pre-indexed in another index. Both formats are defined below with examples. -==== Inline Shape Definition +==== Inline shape definition Similar to the `geo_point` type, the `geo_shape` query uses http://geojson.org[GeoJSON] to represent shapes. @@ -169,7 +169,7 @@ GET /example_points/_search // TESTRESPONSE[s/"took" : 17/"took" : $body.took/] -==== Pre-Indexed Shape +==== Pre-indexed shape The query also supports using a shape which has already been indexed in another index. This is particularly useful for when you have a pre-defined list of @@ -229,7 +229,7 @@ GET /example/_search -------------------------------------------------- -==== Spatial Relations +==== Spatial relations The following is a complete list of spatial relation operators available when searching a geo field: @@ -244,7 +244,7 @@ geometry. Line geometries are not supported. geometry. [discrete] -==== Ignore Unmapped +==== Ignore unmapped When set to `true` the `ignore_unmapped` option will ignore an unmapped field and will not match any documents for this query. This can be useful when