pelias / documentation

All things documentation for Pelias
Creative Commons Attribution 4.0 International
226 stars 99 forks source link

Docs show different example results than what you see in the service now #194

Open rmglennon opened 7 years ago

rmglennon commented 7 years ago

These are my notes as I went through documentation as part of #193.

Some examples in the documentation list the results that are returned from the request. Because these were added ages ago, they may differ from what is returned by the service right now. It's not too big of a deal in most cases and people should expect these to change over time, but the reverse with Tour Eiffel and autocomplete in Union Square are different enough to cause confusion if someone tried to compare the docs with the current results.

place old href https://search.mapzen.com/v1/place? new href https://mapzen.github.io/search-sandbox/?query=place&

reverse old href https://search.mapzen.com/v1/reverse? new href https://mapzen.github.io/search-sandbox/?query=reverse&

Tour Eiffel - # 3 (not # 1) result now for https://mapzen.github.io/search-sandbox/?query=reverse&point.lat=48.858268&point.lon=2.294471

search old href https://search.mapzen.com/v1/search? new href https://mapzen.github.io/search-sandbox/?query=search&

https://mapzen.github.io/search-sandbox/?query=search&text=YMCA gives different top 10 results (and 1 now is in Slovakia)

Every query on page has different top 10 result list

These results are a lot different: https://mapzen.github.io/search-sandbox/?query=search&text=YMCA&sources=oa

structured old href http://search.mapzen.com/v1/search/structured? new href https://mapzen.github.io/search-sandbox/?query=search/structured&

Note: + in URL is converted straight to + https://mapzen.github.io/search-sandbox/?query=search/structured&address=Rue+de+Rivoli&locality=Paris&region=France (and search is for Rue+de+Rivoli, so changed + to space so they show up correctly in text box)... I recall we used the + originally because of cached results.

so many examples in this section

autocomplete old href https://search.mapzen.com/v1/autocomplete? new href https://mapzen.github.io/search-sandbox/?query=autocomplete&

Union Square from SF is not returned at all https://mapzen.github.io/search-sandbox/?query=autocomplete&focus.point.lat=37.7&focus.point.lon=-122.4&text=union square

Now gives all results in NY https://mapzen.github.io/search-sandbox/?query=autocomplete&focus.point.lat=40.7&focus.point.lon=-73.9&text=union square

Different results with and without focus point (no Malta) https://mapzen.github.io/search-sandbox/?query=autocomplete&focus.point.lat=52.5&focus.point.lon=13.3&text=hard rock cafe

Different results https://mapzen.github.io/search-sandbox/?query=autocomplete&sources=openaddresses&text=pennsylvania

Different results https://mapzen.github.io/search-sandbox/?query=autocomplete&text=starbuck&layers=venue

MartinLyne commented 6 years ago

None of the mapzen links work right now. Using the search-sandbox gets a page at least, but requests from the pages don't work.