Browse Source

rEADME: use inline rather than block code delimiters.

DOCS.md
	-Replace inline use of ```code``` with `code`, to reduce
	character bloat and since that's what the inline delimiters are
	meant for.
pull/126/head
Severyn Kozak 10 years ago
parent
commit
435c45562c
  1. 28
      DOCS.md

28
DOCS.md

@ -10,15 +10,15 @@ Full text search endpoint which queries the elasticsearch doc store, slightly sl
* **lon**: longitude
* **zoom**: zoom level from which you wish to view the world
* **size**: number of results requested (defaults to 10)
* **layers**: datasets you wish to query (defaults to ```poi,admin,address```).
* valid values are ```poi```, ```admin``` or ```address```
* ```poi``` expands internally to ```geoname```, ```osmnode```, ```osmway```
* ```admin``` expands to ```admin0```, ```admin1```, ```admin2```, ```neighborhood```, ```locality```, ```local_admin```
* ```address``` expands to ```osmaddress```, ```openaddresses```
* can also be specific to one particular dataset, for example ```geoname```
* **layers**: datasets you wish to query (defaults to `poi,admin,address`).
* valid values are `poi`, `admin` or `address`
* `poi` expands internally to `geoname`, `osmnode`, `osmway`
* `admin` expands to `admin0`, `admin1`, `admin2`, `neighborhood`, `locality`, `local_admin`
* `address` expands to `osmaddress`, `openaddresses`
* can also be specific to one particular dataset, for example `geoname`
* **bbox**: the bounding box from which you want all your results to come
* can be one of the following comma separated string values
* "southwest_lng,southwest_lat,northeast_lng,northeast_lat" ```L.latLngBounds(southwestLatLng, northeastLatLng).toBBoxString()```
* "southwest_lng,southwest_lat,northeast_lng,northeast_lat" `L.latLngBounds(southwestLatLng, northeastLatLng).toBBoxString()`
* bottom left lon, bottom left lat, top right lon, top right lat
* left, bottom, right, top
* min longitude, min latitude, max longitude, max latitude
@ -40,7 +40,7 @@ This is a coarse forward geocoder endpoint which only searches admin dataset lay
* **zoom**: zoom level from which you wish to view the world
* **bbox**: the bounding box frome which you want all your results to come
* **size**: (defaults to 10)
* **layers**: (defaults to ```admin```)
* **layers**: (defaults to `admin`)
* **details**: (defaults to `true`)
@ -57,7 +57,7 @@ The autocomplete endpoint, it offers fast response time. Mixes results from arou
#### Optional Parameters
* **zoom**: zoom level from which you wish to view the world
* **size**: number of results requested (defaults to 10)
* **layers**: datasets you wish to query (defaults to ```poi,admin,address```)
* **layers**: datasets you wish to query (defaults to `poi,admin,address`)
* **details**: (defaults to `true`)
@ -74,13 +74,13 @@ Only queries the admin layers.
#### Optional Parameters
* **zoom**: zoom level from which you wish to view the world
* **size**: number of results requested (defaults to 10)
* **layers**: datasets you wish to query (defaults to ```admin```)
* **layers**: datasets you wish to query (defaults to `admin`)
* **details**: (defaults to `true`)
## /suggest/nearby
Works as autocomplete for places located near a latitude/longitude, this endpoint is the same as ```/suggest``` but the results are all from within 50 kilometers of the specified point. Unlike ```/suggest```, ```/suggest/nearby``` does not mix results from different precision levels (500km, 1000km etc from lat/lon).
Works as autocomplete for places located near a latitude/longitude, this endpoint is the same as `/suggest` but the results are all from within 50 kilometers of the specified point. Unlike `/suggest`, `/suggest/nearby` does not mix results from different precision levels (500km, 1000km etc from lat/lon).
#### Required Parameters
* **input**: query string
@ -91,7 +91,7 @@ Works as autocomplete for places located near a latitude/longitude, this endpoin
#### Optional Parameters
* **zoom**: zoom level from which you wish to view the world
* **size**: number of results you need (defaults to 10)
* **layers**: datasets you wish to query (defaults to ```poi,admin,address```)
* **layers**: datasets you wish to query (defaults to `poi,admin,address`)
* **details**: (defaults to `true`)
@ -106,7 +106,7 @@ Reverse geocoding endpoint.
#### Optional Parameters
* **zoom**: zoom level from which you wish to view the world
* **bbox**: bounding box
* **layers**: (defaults to ```poi,admin,address```)
* **layers**: (defaults to `poi,admin,address`)
* **details**: (defaults to `true`)
@ -118,6 +118,6 @@ Retrieves a document or multiple documents at once.
* one of **id** or **ids**
* **id**:
* unique id of the document to be retrieved
* should be in the form of type:id, for example: ```geoname:4163334```
* should be in the form of type:id, for example: `geoname:4163334`
* **ids**:
* if multiple docs are to be fetched in bulk, an array of ids

Loading…
Cancel
Save