From d893dc3e6da2ae5388053e73b429980489bbd6d0 Mon Sep 17 00:00:00 2001 From: Joxit Date: Fri, 19 Aug 2022 15:19:56 +0200 Subject: [PATCH] fix: using the right order of the layers and adding missing ones --- autocomplete.md | 23 ++++++++++++++--------- reverse.md | 24 +++++++++++++++--------- search.md | 11 ++++++++--- 3 files changed, 37 insertions(+), 21 deletions(-) diff --git a/autocomplete.md b/autocomplete.md index 54fd8ce..4edbad5 100644 --- a/autocomplete.md +++ b/autocomplete.md @@ -134,23 +134,28 @@ without `sources=openaddresses` you will find the most popular Pennsylvanias fir ### Layers -The type of record is referred to as its `layer`. All records are indexed into the following layers: +The type of record is referred to as its `layer`. All records are indexed into the following layers (sorted by granularity): |layer|description| |----|----| |`venue`|points of interest, businesses, things with walls| |`address`|places with a street address| |`street`|streets,roads,highways| -|`country`|places that issue passports, nations, nation-states| -|`macroregion`|a related group of regions. Mostly in Europe| -|`region`|states and provinces| -|`macrocounty`|a related group of counties. Mostly in Europe.| -|`county`|official governmental area; usually bigger than a locality, almost always smaller than a region| +|`neighbourhood`|social communities, neighbourhoods| +|`borough`|a local administrative boundary| |`locality`|towns, hamlets, cities| |`localadmin`|local administrative boundaries| -|`borough`| a local administrative boundary, currently only used for New York City| -|`neighbourhood`|social communities, neighbourhoods| -|`coarse`|alias for simultaneously using all administrative layers (everything except `venue` and `address`)| +|`county`|official governmental area; usually bigger than a locality, almost always smaller than a region| +|`macrocounty`|a related group of counties. Mostly in Europe.| +|`region`|states and provinces| +|`macroregion`|a related group of regions. Mostly in Europe| +|`dependency`|places that issue passports, dependent on a parent country or member of an empire such as French Polynesia member of French empire| +|`country`|places that issue passports, nations, nation-states| +|`empire`|contains one country and many dependencies| +|`continent`|eight continents on earth| +|`marinearea`|water areas smaller than oceans| +|`ocean`|seven oceans on earth| +|`coarse`|alias for simultaneously using all administrative layers (everything except `venue`, `address` and `street`)| |`postalcode`|postal code used by mail services| > /v1/autocomplete?__layers=coarse__&text=starbuck diff --git a/reverse.md b/reverse.md index 9690f25..299651e 100644 --- a/reverse.md +++ b/reverse.md @@ -62,21 +62,27 @@ Without specifying further, reverse geocoding doesn't restrict results to a part Here are all the supported layers and their meanings. -|layer|description| +||layer|description| |----|----| |`venue`|points of interest, businesses, things with walls| |`address`|places with a street address| |`street`|streets,roads,highways| -|`country`|places that issue passports, nations, nation-states| -|`macroregion`|a related group of regions. Mostly in Europe| -|`region`|states and provinces| -|`macrocounty`|a related group of counties. Mostly in Europe.| -|`county`|official governmental area; usually bigger than a locality, almost always smaller than a region| +|`neighbourhood`|social communities, neighbourhoods| +|`borough`|a local administrative boundary| |`locality`|towns, hamlets, cities| |`localadmin`|local administrative boundaries| -|`borough`| a local administrative boundary, currently only used for New York City| -|`neighbourhood`|social communities, neighbourhoods| -|`coarse`|alias for simultaneously using all administrative layers (everything except `venue` and `address`)| +|`county`|official governmental area; usually bigger than a locality, almost always smaller than a region| +|`macrocounty`|a related group of counties. Mostly in Europe.| +|`region`|states and provinces| +|`macroregion`|a related group of regions. Mostly in Europe| +|`dependency`|places that issue passports, dependent on a parent country or member of an empire such as French Polynesia member of French empire| +|`country`|places that issue passports, nations, nation-states| +|`empire`|contains one country and many dependencies| +|`continent`|eight continents on earth| +|`marinearea`|water areas smaller than oceans| +|`ocean`|seven oceans on earth| +|`coarse`|alias for simultaneously using all administrative layers (everything except `venue`, `address` and `street`)| +|`postalcode`|postal code used by mail services| ### Filter by country diff --git a/search.md b/search.md index 0b391fb..ac5c024 100644 --- a/search.md +++ b/search.md @@ -351,15 +351,20 @@ Here's a list of the types of places you could find in the results, sorted by gr |`address`|places with a street address| |`street`|streets,roads,highways| |`neighbourhood`|social communities, neighbourhoods| -|`borough`|a local administrative boundary, currently only used for New York City| -|`localadmin`|local administrative boundaries| +|`borough`|a local administrative boundary| |`locality`|towns, hamlets, cities| +|`localadmin`|local administrative boundaries| |`county`|official governmental area; usually bigger than a locality, almost always smaller than a region| |`macrocounty`|a related group of counties. Mostly in Europe.| |`region`|states and provinces| |`macroregion`|a related group of regions. Mostly in Europe| +|`dependency`|places that issue passports, dependent on a parent country or member of an empire such as French Polynesia member of French empire| |`country`|places that issue passports, nations, nation-states| -|`coarse`|alias for simultaneously using all administrative layers (everything except `venue` and `address`)| +|`empire`|contains one country and many dependencies| +|`continent`|eight continents on earth| +|`marinearea`|water areas smaller than oceans| +|`ocean`|seven oceans on earth| +|`coarse`|alias for simultaneously using all administrative layers (everything except `venue`, `address` and `street`)| |`postalcode`|postal code used by mail services| > [/v1/search?text=YMCA&__layers=venue,address__](https://pelias.github.io/compare/#/v1/search%3Flayers=venue,address&text=ymca)