pelias
/
api
mirror of https://github.com/pelias/api.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

Update docs for search and suggest

pull/215/head
Julian Simioni 9 years ago
parent
86424b8bbe
commit
39c5cb671d
1 changed files with 2 additions and 2 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      public/apiDoc.md

4
public/apiDoc.md
Unescape View File

@ -3,7 +3,7 @@
The full text search endpoint that matches the name of a place to points on the planet. The full text search endpoint that matches the name of a place to points on the planet.
#### Required Parameters #### Required Parameters
* `input`: the string to search for (eg `new york city` or `london`) * `text`: the string to search for (eg `new york city` or `london`)
#### Optional Parameters #### Optional Parameters
* `lat`, `lon`: the latitude/longitude coordinates to bias search results towards (may increase relevancy) * `lat`, `lon`: the latitude/longitude coordinates to bias search results towards (may increase relevancy)
@ -43,7 +43,7 @@ The autocompletion endpoint that offers very fast response times; ideal for comp
results from around the provided lat/lon coordinates and also from precision level 1 and 3. results from around the provided lat/lon coordinates and also from precision level 1 and 3.
#### Required Parameters #### Required Parameters
* `input`: query string * `text`: query string
* `lat`, `lon`: The latitude/longitude coordinates to bias results towards. * `lat`, `lon`: The latitude/longitude coordinates to bias results towards.
* `lat`/`lon` are currently **required** because of this [open issue](https://github.com/elasticsearch/elasticsearch/issues/6444) * `lat`/`lon` are currently **required** because of this [open issue](https://github.com/elasticsearch/elasticsearch/issues/6444)

Write Preview
Loading…
Cancel
Save