Skip to content

Commit ac71f1b

Browse files
missinglinkclintongormley
authored andcommitted
[docs] formatting and general pedantry
I'm not sure if the `distance-units` section is totally clear, when using the 'Geohash Cell Filter' and omitting a unit, the default is to interpret the integer as the 'length of the geohash prefix', not to default it to 'meter'. Maybe I'm being pedantic. Closes #8744
1 parent 48ec659 commit ac71f1b

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/reference/api-conventions.asciidoc

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ to. If `open` is specified then the wildcard expression is expanded to only
4848
open indices and if `closed` is specified then the wildcard expression is
4949
expanded only to closed indices. Also both values (`open,closed`) can be
5050
specified to expand to all indices.
51-
+
52-
If `none` is specified then wildcard expansion will be disabled and if `all`
53-
is specified, wildcard expressions will expand to all indices (this is equivalent
51+
52+
If `none` is specified then wildcard expansion will be disabled and if `all`
53+
is specified, wildcard expressions will expand to all indices (this is equivalent
5454
to specifying `open,closed`).
5555

5656
The defaults settings for the above parameters depend on the api being used.
@@ -68,7 +68,7 @@ The following options can be applied to all of the REST APIs.
6868

6969
When appending `?pretty=true` to any request made, the JSON returned
7070
will be pretty formatted (use it for debugging only!). Another option is
71-
to set `format=yaml` which will cause the result to be returned in the
71+
to set `?format=yaml` which will cause the result to be returned in the
7272
(sometimes) more readable yaml format.
7373

7474

@@ -77,7 +77,7 @@ to set `format=yaml` which will cause the result to be returned in the
7777

7878
Statistics are returned in a format suitable for humans
7979
(eg `"exists_time": "1h"` or `"size": "1kb"`) and for computers
80-
(eg `"exists_time_in_millis": 3600000`` or `"size_in_bytes": 1024`).
80+
(eg `"exists_time_in_millis": 3600000` or `"size_in_bytes": 1024`).
8181
The human readable values can be turned off by adding `?human=false`
8282
to the query string. This makes sense when the stats results are
8383
being consumed by a monitoring tool, rather than intended for human
@@ -88,7 +88,7 @@ consumption. The default for the `human` flag is
8888
=== Flat Settings
8989

9090
The `flat_settings` flag affects rendering of the lists of settings. When
91-
flat_settings` flag is `true` settings are returned in a flat format:
91+
`flat_settings` flag is `true` settings are returned in a flat format:
9292

9393
[source,js]
9494
--------------------------------------------------
@@ -160,8 +160,7 @@ can be specified as a whole number representing time in milliseconds, or as a ti
160160
=== Distance Units
161161

162162
Wherever distances need to be specified, such as the `distance` parameter in
163-
the <<query-dsl-geo-distance-filter>>) or the `precision` parameter in the
164-
<<query-dsl-geohash-cell-filter>>, the default unit if none is specified is
163+
the <<query-dsl-geo-distance-filter>>), the default unit if none is specified is
165164
the meter. Distances can be specified in other units, such as `"1km"` or
166165
`"2mi"` (2 miles).
167166

@@ -178,6 +177,10 @@ Centimeter:: `cm` or `centimeters`
178177
Millimeter:: `mm` or `millimeters`
179178
Nautical mile:: `NM`, `nmi` or `nauticalmiles`
180179

180+
The `precision` parameter in the <<query-dsl-geohash-cell-filter>> accepts
181+
distances with the above units, but if no unit is specified, then the
182+
precision is interpreted as the length of the geohash.
183+
181184
[[fuzziness]]
182185
[float]
183186
=== Fuzziness

0 commit comments

Comments
 (0)