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.

Sign up for GitHub

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] Remove camel case variations #88650

Merged
merged 2 commits into from
Jul 20, 2022
Merged

[DOCS] Remove camel case variations #88650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8173b1c
[DOCS] Remove camel case variations. Closes #73417
abdonpijpelink Jul 20, 2022
1f143b3
[DOCS] Switch to sentence casing in titles
abdonpijpelink Jul 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions docs/reference/query-dsl/geo-bounding-box-query.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ GET my_locations,my_geoshapes/_search
--------------------------------------------------

[discrete]
==== Query Options
==== Query options

[cols="<,<",options="header",]
|=======================================================================
Expand All @@ -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]
--------------------------------------------------
Expand Down Expand Up @@ -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].
Expand Down Expand Up @@ -238,7 +238,7 @@ GET my_locations/_search
--------------------------------------------------

[discrete]
===== Lat Lon As String
===== Lat lon as string

Format in `lat,lon`.

Expand All @@ -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]
--------------------------------------------------
Expand Down Expand Up @@ -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]
--------------------------------------------------
Expand All @@ -379,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
Expand All @@ -395,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,
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/query-dsl/geo-distance-query.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
--------------------------------------------------
Expand All @@ -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].
Expand All @@ -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].

Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/reference/query-dsl/geo-polygon-query.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",]
|=======================================================================
Expand All @@ -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]`

Expand Down Expand Up @@ -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`.

Expand Down Expand Up @@ -151,7 +151,7 @@ The query *requires* the <<geo-point,`geo_point`>> 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
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/query-dsl/geo-shape-query.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand Down