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

update formatting, add bold to highlight queries

pull/124/head
rmglennon 9 years ago committed by Julian Simioni
parent
4f521a6002
commit
79de4e6680
No known key found for this signature in database
GPG Key ID: B9EEB0C6EE0910A1
3 changed files with 8 additions and 8 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. 10
      autocomplete.md
  2. 4
      place.md
  3. 2
      search.md

10
autocomplete.md
Unescape View File

@ -19,7 +19,7 @@ To focus your search based upon a geographical area, such as the center of the u
From San Francisco: From San Francisco:
> >
[/v1/autocomplete?api_key=search-hnopfLZ&focus.point.lat=37.7&focus.point.lon=-122.4&text=union square](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&focus.point.lat=37.7&focus.point.lon=-122.4&text=union square) [/v1/autocomplete?api_key=search-hnopfLZ&__focus.point.lat=37.7&focus.point.lon=-122.4&text=union square__](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&focus.point.lat=37.7&focus.point.lon=-122.4&text=union square)
``` ```
1) Union Square, San Francisco County, CA 1) Union Square, San Francisco County, CA
@ -29,7 +29,7 @@ From San Francisco:
From New York City: From New York City:
> >
[/v1/autocomplete?api_key=search-hnopfLZ&focus.point.lat=40.7&focus.point.lon=-73.9&text=union square](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&focus.point.lat=40.7&focus.point.lon=-73.9&text=union square) [/v1/autocomplete?api_key=search-hnopfLZ&__focus.point.lat=40.7&focus.point.lon=-73.9&text=union square__](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&focus.point.lat=40.7&focus.point.lon=-73.9&text=union square)
``` ```
1) Union Square, New York County, NY 1) Union Square, New York County, NY
@ -38,7 +38,7 @@ From New York City:
The `/autocomplete` endpoint can promote nearby results to the top of the list, while still allowing important matches from farther away to be visible. For example, searching `hard rock cafe` with a focus on Berlin: The `/autocomplete` endpoint can promote nearby results to the top of the list, while still allowing important matches from farther away to be visible. For example, searching `hard rock cafe` with a focus on Berlin:
> [/v1/autocomplete?api_key=search-hnopfLZ&focus.point.lat=52.5&focus.point.lon=13.3&text=hard rock cafe](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&focus.point.lat=52.5&focus.point.lon=13.3&text=hard rock cafe) > [/v1/autocomplete?api_key=search-hnopfLZ&__focus.point.lat=52.5&focus.point.lon=13.3&text=hard rock cafe__](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&focus.point.lat=52.5&focus.point.lon=13.3&text=hard rock cafe)
with `focus.point` you will find the Berlin restaurant first: with `focus.point` you will find the Berlin restaurant first:
``` ```
@ -65,7 +65,7 @@ The `sources` parameter allows you to specify from which data sources you'd like
* `geonames` or `gn` * `geonames` or `gn`
* `whosonfirst` or `wof` * `whosonfirst` or `wof`
> [/v1/autocomplete?api_key=search-hnopfLZ&sources=openaddresses&text=pennsylvania](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&sources=openaddresses&text=pennsylvania) > [/v1/autocomplete?api_key=search-hnopfLZ&__sources=openaddresses__&text=pennsylvania](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&sources=openaddresses&text=pennsylvania)
with `sources=openaddresses` you will only find addresses on Pennsylvania Ave or Street: with `sources=openaddresses` you will only find addresses on Pennsylvania Ave or Street:
``` ```
@ -99,7 +99,7 @@ The type of record is referred to as its `layer`. All records are indexed into t
You can also refer to all the administrative hierarchy layers with a single alias, `coarse`. You can also refer to all the administrative hierarchy layers with a single alias, `coarse`.
> [/v1/autocomplete?api_key=search-hnopfLZ&layers=coarse&text=starbuck](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&layers=coarse&text=starbuck) > [/v1/autocomplete?api_key=search-hnopfLZ&__layers=coarse__&text=starbuck](https://search.mapzen.com/v1/autocomplete?api_key=search-hnopfLZ&layers=coarse&text=starbuck)
with `layers=coarse` you will see only administrative areas with names containing Starbuck with `layers=coarse` you will see only administrative areas with names containing Starbuck

4
place.md
Unescape View File

@ -9,13 +9,13 @@ These `gid` strings should not be built manually, but rather used directly as-is
For example, this `/place` query looks up the Eiffel Tower in OpenStreetMap (OSM): For example, this `/place` query looks up the Eiffel Tower in OpenStreetMap (OSM):
> [/v1/place?api_key=search-hnopfLZ&ids=openstreetmap:venue:way:5013364](https://search.mapzen.com/v1/place?api_key=search-hnopfLZ&ids=openstreetmap:venue:way:5013364) > [/v1/place?api_key=search-hnopfLZ&__ids=openstreetmap:venue:way:5013364__](https://search.mapzen.com/v1/place?api_key=search-hnopfLZ&ids=openstreetmap:venue:way:5013364)
## Search for multiple places in a query ## Search for multiple places in a query
To search for more than one `/place` in a request, join multiple values together and separate them with a comma. For example, this `/place` query looks up the Eiffel Tower in OpenStreetMap and the borough of Manhattan in Who's on First: To search for more than one `/place` in a request, join multiple values together and separate them with a comma. For example, this `/place` query looks up the Eiffel Tower in OpenStreetMap and the borough of Manhattan in Who's on First:
> [/v1/place?api_key=search-hnopfLZ&ids=openstreetmap:venue:way:5013364,whosonfirst:borough:421205771](https://search.mapzen.com/v1/place?api_key=search-hnopfLZ&ids=openstreetmap:venue:way:5013364,whosonfirst:borough:421205771) > [/v1/place?api_key=search-hnopfLZ&__ids=openstreetmap:venue:way:5013364,whosonfirst:borough:421205771__](https://search.mapzen.com/v1/place?api_key=search-hnopfLZ&ids=openstreetmap:venue:way:5013364,whosonfirst:borough:421205771)
The results are returned in the order requested. The results are returned in the order requested.

2
search.md
Unescape View File

@ -305,7 +305,7 @@ If you use the `sources` parameter, you can choose which of these data sources t
Because OpenAddresses is, as the name suggests, only address data, here's what you can expect to find: Because OpenAddresses is, as the name suggests, only address data, here's what you can expect to find:
> * 0 Ymca, New Brunswick * 0 Ymca, New Brunswick
* 0 Ymca Drive, Cary, NC * 0 Ymca Drive, Cary, NC
* 14843 Ymca Lane, Cormorant, MN * 14843 Ymca Lane, Cormorant, MN
* 14660 Ymca Lane, Cormorant, MN * 14660 Ymca Lane, Cormorant, MN

Write Preview
Loading…
Cancel
Save