Skip to content

Commit fc0ac19

Browse files
authored
[DOCS] Correct spelling for geo terms (#76028)
Changes: * Use "geopoint" when not referring to the literal field type * Use "geoshape" when not referring to the literal field type or query type * Use "GeoJSON" consistently
1 parent 10ffb93 commit fc0ac19

17 files changed

+74
-75
lines changed

docs/reference/aggregations/bucket/geodistance-aggregation.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ The specified field must be of type `geo_point` (which can only be set explicitl
8888

8989
* Object format: `{ "lat" : 52.3760, "lon" : 4.894 }` - this is the safest format as it is the most explicit about the `lat` & `lon` values
9090
* String format: `"52.3760, 4.894"` - where the first number is the `lat` and the second is the `lon`
91-
* Array format: `[4.894, 52.3760]` - which is based on the `GeoJson` standard and where the first number is the `lon` and the second one is the `lat`
91+
* Array format: `[4.894, 52.3760]` - which is based on the GeoJSON standard where the first number is the `lon` and the second one is the `lat`
9292

9393
By default, the distance unit is `m` (meters) but it can also accept: `mi` (miles), `in` (inches), `yd` (yards), `km` (kilometers), `cm` (centimeters), `mm` (millimeters).
9494

docs/reference/aggregations/metrics/geocentroid-aggregation.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ The response for the above aggregation:
153153
[[geocentroid-aggregation-geo-shape]]
154154
==== Geo Centroid Aggregation on `geo_shape` fields
155155

156-
The centroid metric for geo-shapes is more nuanced than for points. The centroid of a specific aggregation bucket
156+
The centroid metric for geoshapes is more nuanced than for points. The centroid of a specific aggregation bucket
157157
containing shapes is the centroid of the highest-dimensionality shape type in the bucket. For example, if a bucket contains
158158
shapes comprising of polygons and lines, then the lines do not contribute to the centroid metric. Each type of shape's
159159
centroid is calculated differently. Envelopes and circles ingested via the <<ingest-circle-processor>> are treated
@@ -233,12 +233,12 @@ POST /places/_search?size=0
233233
.Using `geo_centroid` as a sub-aggregation of `geohash_grid`
234234
====
235235
The <<search-aggregations-bucket-geohashgrid-aggregation,`geohash_grid`>>
236-
aggregation places documents, not individual geo-points, into buckets. If a
236+
aggregation places documents, not individual geopoints, into buckets. If a
237237
document's `geo_point` field contains <<array,multiple values>>, the document
238-
could be assigned to multiple buckets, even if one or more of its geo-points are
238+
could be assigned to multiple buckets, even if one or more of its geopoints are
239239
outside the bucket boundaries.
240240
241241
If a `geocentroid` sub-aggregation is also used, each centroid is calculated
242-
using all geo-points in a bucket, including those outside the bucket boundaries.
242+
using all geopoints in a bucket, including those outside the bucket boundaries.
243243
This can result in centroids outside of bucket boundaries.
244244
====

docs/reference/indices/index-mgmt.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ image::images/index-mgmt/management_index_component_template.png[Component templ
144144
section blank.
145145

146146
. Define a mapping that contains an <<object,object>> field named `geo` with a
147-
child <<geo-point,geo-point>> field named `coordinates`:
147+
child <<geo-point,`geo_point`>> field named `coordinates`:
148148
+
149149
[role="screenshot"]
150150
image::images/index-mgmt/management-index-templates-mappings.png[Mapped fields page]

docs/reference/ingest/geo-match-enrich-policy-type-ex.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ pipeline. In the pipeline, add an <<enrich-processor,enrich processor>> that
8282
includes:
8383

8484
* Your enrich policy.
85-
* The `field` of incoming documents used to match the geo_shape of documents
85+
* The `field` of incoming documents used to match the geoshape of documents
8686
from the enrich index.
8787
* The `target_field` used to store appended enrich data for incoming documents.
8888
This field contains the `match_field` and `enrich_fields` specified in your
8989
enrich policy.
90-
* The `shape_relation`, which indicates how the processor matches geo_shapes in
91-
incoming documents to geo_shapes in documents from the enrich index. See
90+
* The `shape_relation`, which indicates how the processor matches geoshapes in
91+
incoming documents to geoshapes in documents from the enrich index. See
9292
<<_spatial_relations>> for valid options and more information.
9393

9494
[source,console]

docs/reference/ingest/processors/enrich.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ See <<ingest-enriching-data,enrich data>> section for more information about how
2020
| `ignore_missing` | no | false | If `true` and `field` does not exist, the processor quietly exits without modifying the document
2121
| `override` | no | true | If processor will update fields with pre-existing non-null-valued field. When set to `false`, such fields will not be touched.
2222
| `max_matches` | no | 1 | The maximum number of matched documents to include under the configured target field. The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128.
23-
| `shape_relation` | no | `INTERSECTS` | A spatial relation operator used to match the <<geo-shape,geo_shape>> of incoming documents to documents in the enrich index. This option is only used for `geo_match` enrich policy types. See <<_spatial_relations>> for operators and more information.
23+
| `shape_relation` | no | `INTERSECTS` | A spatial relation operator used to match the <<geo-shape,geoshape>> of incoming documents to documents in the enrich index. This option is only used for `geo_match` enrich policy types. See <<_spatial_relations>> for operators and more information.
2424

2525
include::common-options.asciidoc[]
2626
|======

docs/reference/mapping/types/geo-point.asciidoc

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
[[geo-point]]
2-
=== Geo-point field type
2+
=== Geopoint field type
33
++++
4-
<titleabbrev>Geo-point</titleabbrev>
4+
<titleabbrev>Geopoint</titleabbrev>
55
++++
66

77
Fields of type `geo_point` accept latitude-longitude pairs, which can be used:
88

9-
* to find geo-points within a <<query-dsl-geo-bounding-box-query,bounding box>>,
9+
* to find geopoints within a <<query-dsl-geo-bounding-box-query,bounding box>>,
1010
within a certain <<query-dsl-geo-distance-query,distance>> of a central point,
11-
or within a <<query-dsl-geo-polygon-query,polygon>> or within a <<query-dsl-geo-shape-query,geo_shape query>>.
11+
or within a <<query-dsl-geo-polygon-query,polygon>> or within a <<query-dsl-geo-shape-query,`geo_shape` query>>.
1212
* to aggregate documents <<search-aggregations-bucket-geohashgrid-aggregation,geographically>>
1313
or by <<search-aggregations-bucket-geodistance-aggregation,distance>> from a central point.
1414
* to integrate distance into a document's <<query-dsl-function-score-query,relevance score>>.
1515
* to <<geo-sorting,sort>> documents by distance.
1616

17-
There are five ways that a geo-point may be specified, as demonstrated below:
17+
There are five ways that a geopoint may be specified, as demonstrated below:
1818

1919
[source,console]
2020
--------------------------------------------------
@@ -31,7 +31,7 @@ PUT my-index-000001
3131
3232
PUT my-index-000001/_doc/1
3333
{
34-
"text": "Geo-point as an object",
34+
"text": "Geopoint as an object",
3535
"location": { <1>
3636
"lat": 41.12,
3737
"lon": -71.34
@@ -40,25 +40,25 @@ PUT my-index-000001/_doc/1
4040
4141
PUT my-index-000001/_doc/2
4242
{
43-
"text": "Geo-point as a string",
43+
"text": "Geopoint as a string",
4444
"location": "41.12,-71.34" <2>
4545
}
4646
4747
PUT my-index-000001/_doc/3
4848
{
49-
"text": "Geo-point as a geohash",
49+
"text": "Geopoint as a geohash",
5050
"location": "drm3btev3e86" <3>
5151
}
5252
5353
PUT my-index-000001/_doc/4
5454
{
55-
"text": "Geo-point as an array",
55+
"text": "Geopoint as an array",
5656
"location": [ -71.34, 41.12 ] <4>
5757
}
5858
5959
PUT my-index-000001/_doc/5
6060
{
61-
"text": "Geo-point as a WKT POINT primitive",
61+
"text": "Geopoint as a WKT POINT primitive",
6262
"location" : "POINT (-71.34 41.12)" <5>
6363
}
6464
@@ -81,20 +81,20 @@ GET my-index-000001/_search
8181
}
8282
--------------------------------------------------
8383

84-
<1> Geo-point expressed as an object, with `lat` and `lon` keys.
85-
<2> Geo-point expressed as a string with the format: `"lat,lon"`.
86-
<3> Geo-point expressed as a geohash.
87-
<4> Geo-point expressed as an array with the format: [ `lon`, `lat`]
88-
<5> Geo-point expressed as a https://docs.opengeospatial.org/is/12-063r5/12-063r5.html[Well-Known Text]
84+
<1> Geopoint expressed as an object, with `lat` and `lon` keys.
85+
<2> Geopoint expressed as a string with the format: `"lat,lon"`.
86+
<3> Geopoint expressed as a geohash.
87+
<4> Geopoint expressed as an array with the format: [ `lon`, `lat`]
88+
<5> Geopoint expressed as a https://docs.opengeospatial.org/is/12-063r5/12-063r5.html[Well-Known Text]
8989
POINT with the format: `"POINT(lon lat)"`
90-
<6> A geo-bounding box query which finds all geo-points that fall inside the box.
90+
<6> A geo-bounding box query which finds all geopoints that fall inside the box.
9191

9292
[IMPORTANT]
93-
.Geo-points expressed as an array or string
93+
.Geopoints expressed as an array or string
9494
==================================================
9595
96-
Please note that string geo-points are ordered as `lat,lon`, while array
97-
geo-points are ordered as the reverse: `lon,lat`.
96+
Please note that string geopoints are ordered as `lat,lon`, while array
97+
geopoints are ordered as the reverse: `lon,lat`.
9898
9999
Originally, `lat,lon` was used for both array and string, but the array
100100
format was changed early on to conform to the format used by GeoJSON.
@@ -121,17 +121,17 @@ The following parameters are accepted by `geo_point` fields:
121121

122122
<<ignore-malformed,`ignore_malformed`>>::
123123

124-
If `true`, malformed geo-points are ignored. If `false` (default),
125-
malformed geo-points throw an exception and reject the whole document.
126-
A geo-point is considered malformed if its latitude is outside the range
124+
If `true`, malformed geopoints are ignored. If `false` (default),
125+
malformed geopoints throw an exception and reject the whole document.
126+
A geopoint is considered malformed if its latitude is outside the range
127127
-90 <= latitude <= 90, or if its longitude is outside the range -180 <= longitude <= 180.
128128
Note that this cannot be set if the `script` parameter is used.
129129

130130
`ignore_z_value`::
131131

132132
If `true` (default) three dimension points will be accepted (stored in source)
133133
but only latitude and longitude values will be indexed; the third dimension is
134-
ignored. If `false`, geo-points containing any more than latitude and longitude
134+
ignored. If `false`, geopoints containing any more than latitude and longitude
135135
(two dimensions) values throw an exception and reject the whole document. Note
136136
that this cannot be set if the `script` parameter is used.
137137

@@ -165,9 +165,9 @@ The following parameters are accepted by `geo_point` fields:
165165
<<runtime-mapping-fields,runtime equivalent>>, and should emit points
166166
as a pair of (lat, lon) double values.
167167

168-
==== Using geo-points in scripts
168+
==== Using geopoints in scripts
169169

170-
When accessing the value of a geo-point in a script, the value is returned as
170+
When accessing the value of a geopoint in a script, the value is returned as
171171
a `GeoPoint` object, which allows access to the `.lat` and `.lon` values
172172
respectively:
173173

docs/reference/mapping/types/geo-shape.asciidoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[geo-shape]]
2-
=== Geo-shape field type
2+
=== Geoshape field type
33
++++
4-
<titleabbrev>Geo-shape</titleabbrev>
4+
<titleabbrev>Geoshape</titleabbrev>
55
++++
66

77
The `geo_shape` data type facilitates the indexing of and searching
@@ -10,14 +10,14 @@ used when either the data being indexed or the queries being executed
1010
contain shapes other than just points.
1111

1212
You can query documents using this type using
13-
<<query-dsl-geo-shape-query,geo_shape Query>>.
13+
a <<query-dsl-geo-shape-query,`geo_shape` query>>.
1414

1515
[[geo-shape-mapping-options]]
1616
[discrete]
1717
==== Mapping Options
1818

19-
The geo_shape mapping maps geo_json geometry objects to the geo_shape
20-
type. To enable it, users must explicitly map fields to the geo_shape
19+
The `geo_shape` mapping maps GeoJSON geometry objects to the `geo_shape`
20+
type. To enable it, users must explicitly map fields to the `geo_shape`
2121
type.
2222

2323
[cols="<,<,<",options="header",]
@@ -58,7 +58,7 @@ entire document.
5858

5959
|`ignore_z_value` |If `true` (default) three dimension points will be accepted (stored in source)
6060
but only latitude and longitude values will be indexed; the third dimension is ignored. If `false`,
61-
geo-points containing any more than latitude and longitude (two dimensions) values throw an exception
61+
geopoints containing any more than latitude and longitude (two dimensions) values throw an exception
6262
and reject the whole document.
6363
| `true`
6464

@@ -291,8 +291,8 @@ POST /example/_doc
291291
--------------------------------------------------
292292
// TEST[catch:/mapper_parsing_exception/]
293293

294-
An `orientation` parameter can be defined when setting the geo_shape mapping (see <<geo-shape-mapping-options>>). This will define vertex
295-
order for the coordinate list on the mapped geo_shape field. It can also be overridden on each document. The following is an example for
294+
An `orientation` parameter can be defined when setting the `geo_shape` mapping (see <<geo-shape-mapping-options>>). This will define vertex
295+
order for the coordinate list on the mapped `geo_shape` field. It can also be overridden on each document. The following is an example for
296296
overriding the orientation on a document:
297297

298298
[source,console]
@@ -313,7 +313,7 @@ POST /example/_doc
313313
[[geo-multipoint]]
314314
===== http://geojson.org/geojson-spec.html#id5[MultiPoint]
315315

316-
The following is an example of a list of geojson points:
316+
The following is an example of a list of GeoJSON points:
317317

318318
[source,console]
319319
--------------------------------------------------
@@ -342,7 +342,7 @@ POST /example/_doc
342342
[[geo-multilinestring]]
343343
===== http://geojson.org/geojson-spec.html#id6[MultiLineString]
344344

345-
The following is an example of a list of geojson linestrings:
345+
The following is an example of a list of GeoJSON linestrings:
346346

347347
[source,console]
348348
--------------------------------------------------
@@ -373,7 +373,7 @@ POST /example/_doc
373373
[[geo-multipolygon]]
374374
===== http://geojson.org/geojson-spec.html#id7[MultiPolygon]
375375

376-
The following is an example of a list of geojson polygons (second polygon contains a hole):
376+
The following is an example of a list of GeoJSON polygons (second polygon contains a hole):
377377

378378
[source,console]
379379
--------------------------------------------------
@@ -404,7 +404,7 @@ POST /example/_doc
404404
[[geo-geometry_collection]]
405405
===== http://geojson.org/geojson-spec.html#geometrycollection[Geometry Collection]
406406

407-
The following is an example of a collection of geojson geometry objects:
407+
The following is an example of a collection of GeoJSON geometry objects:
408408

409409
[source,console]
410410
--------------------------------------------------
@@ -479,5 +479,5 @@ a <<geo-polygon,`polygon`>>.
479479

480480
Due to the complex input structure and index representation of shapes,
481481
it is not currently possible to sort shapes or retrieve their fields
482-
directly. The geo_shape value is only retrievable through the `_source`
482+
directly. The `geo_shape` value is only retrievable through the `_source`
483483
field.

docs/reference/mapping/types/shape.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can query documents using this type using
1818
[discrete]
1919
==== Mapping Options
2020

21-
Like the <<geo-shape, geo_shape>> field type, the `shape` field mapping maps
21+
Like the <<geo-shape,`geo_shape`>> field type, the `shape` field mapping maps
2222
http://geojson.org[GeoJSON] or https://docs.opengeospatial.org/is/12-063r5/12-063r5.html[Well-Known Text]
2323
(WKT) geometry objects to the shape type. To enable it, users must explicitly map
2424
fields to the shape type.
@@ -34,8 +34,8 @@ different ways. 1. Right-hand rule: `right`, `ccw`, `counterclockwise`,
3434
2. Left-hand rule: `left`, `cw`, `clockwise`. The default orientation
3535
(`counterclockwise`) complies with the OGC standard which defines
3636
outer ring vertices in counterclockwise order with inner ring(s) vertices (holes)
37-
in clockwise order. Setting this parameter in the geo_shape mapping explicitly
38-
sets vertex order for the coordinate list of a geo_shape field but can be
37+
in clockwise order. Setting this parameter in the `geo_shape` mapping explicitly
38+
sets vertex order for the coordinate list of a `geo_shape` field but can be
3939
overridden in each individual GeoJSON or WKT document.
4040
| `ccw`
4141

@@ -46,7 +46,7 @@ entire document.
4646

4747
|`ignore_z_value` |If `true` (default) three dimension points will be accepted (stored in source)
4848
but only latitude and longitude values will be indexed; the third dimension is ignored. If `false`,
49-
geo-points containing any more than latitude and longitude (two dimensions) values throw an exception
49+
geopoints containing any more than latitude and longitude (two dimensions) values throw an exception
5050
and reject the whole document.
5151
| `true`
5252

@@ -279,7 +279,7 @@ POST /example/_doc
279279
[[multipoint]]
280280
===== http://geojson.org/geojson-spec.html#id5[MultiPoint]
281281

282-
The following is an example of a list of geojson points:
282+
The following is an example of a list of GeoJSON points:
283283

284284
[source,console]
285285
--------------------------------------------------
@@ -308,7 +308,7 @@ POST /example/_doc
308308
[[multilinestring]]
309309
===== http://geojson.org/geojson-spec.html#id6[MultiLineString]
310310

311-
The following is an example of a list of geojson linestrings:
311+
The following is an example of a list of GeoJSON linestrings:
312312

313313
[source,console]
314314
--------------------------------------------------
@@ -339,7 +339,7 @@ POST /example/_doc
339339
[[multipolygon]]
340340
===== http://geojson.org/geojson-spec.html#id7[MultiPolygon]
341341

342-
The following is an example of a list of geojson polygons (second polygon contains a hole):
342+
The following is an example of a list of GeoJSON polygons (second polygon contains a hole):
343343

344344
[source,console]
345345
--------------------------------------------------
@@ -370,7 +370,7 @@ POST /example/_doc
370370
[[geometry_collection]]
371371
===== http://geojson.org/geojson-spec.html#geometrycollection[Geometry Collection]
372372

373-
The following is an example of a collection of geojson geometry objects:
373+
The following is an example of a collection of GeoJSON geometry objects:
374374

375375
[source,console]
376376
--------------------------------------------------

docs/reference/ml/anomaly-detection/functions/ml-geo-functions.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ For example, JSON data might contain the following transaction coordinates:
7070
// NOTCONSOLE
7171

7272
In {es}, location data is likely to be stored in `geo_point` fields. For more
73-
information, see {ref}/geo-point.html[Geo-point data type]. This data type is
73+
information, see {ref}/geo-point.html[`geo_point` data type]. This data type is
7474
supported natively in {ml-features}. Specifically, {dfeed} when pulling data from
7575
a `geo_point` field, will transform the data into the appropriate `lat,lon` string
7676
format before sending to the {anomaly-job}.

docs/reference/ml/anomaly-detection/ml-configuring-transform.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ The preview {dfeed} API returns the following results, which show that
421421

422422

423423
[[ml-configuring-transform8]]
424-
.Example 8: Transforming geo_point data
424+
.Example 8: Transforming geopoint data
425425

426426
[source,console]
427427
--------------------------------------------------

0 commit comments

Comments
 (0)