honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[GEO] fix docs for geo_point "validate" option 

Documentation states false as the default for "validate", "validate_lon", and "validate_lat" leading to confusion as described in issue #9539. This simple fix corrects the documentation and communicates that these fields will be deprecated and removed in upcoming versions.

closes #9539
This commit is contained in:
Nicholas Knize 2015-03-19 14:46:32 -05:00
parent 6dc06063c7
commit c2ec463cdb
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/reference/mapping/types/geo-point-type.asciidoc
View File

@ -138,15 +138,18 @@ but also all its parent cells (true prefixes) will be indexed as well. The
number of terms that will be indexed depends on the `geohash_precision`.
Defaults to `false`. *Note*: This option implicitly enables `geohash`.
|`validate` |Set to `true` to reject geo points with invalid latitude or
longitude (default is `false`). *Note*: Validation only works when
normalization has been disabled.
|`validate` |Set to `false` to accept geo points with invalid latitude or
longitude (default is `true`). *Note*: Validation only works when
normalization has been disabled. This option will be deprecated and removed
in upcoming releases.
|`validate_lat` |Set to `true` to reject geo points with an invalid
latitude.
|`validate_lat` |Set to `false` to accept geo points with an invalid
latitude (default is `true`). This option will be deprecated and removed
in upcoming releases.
|`validate_lon` |Set to `true` to reject geo points with an invalid
longitude.
|`validate_lon` |Set to `false` to accept geo points with an invalid
longitude (default is `true`). This option will be deprecated and removed
in upcoming releases.
|`normalize` |Set to `true` to normalize latitude and longitude (default
is `true`).