From 71ae7f10f74251ebef13abe8d186276e6255b5d4 Mon Sep 17 00:00:00 2001 From: marc tobias Date: Mon, 20 Aug 2018 19:11:38 +0200 Subject: [PATCH] small typos and wording in the API docs --- docs/api/Overview.md | 4 ++-- docs/api/Reverse.md | 4 ++-- docs/api/Search.md | 35 ++++++++++++++++------------------- 3 files changed, 20 insertions(+), 23 deletions(-) diff --git a/docs/api/Overview.md b/docs/api/Overview.md index 8bf14c43..3fb1c242 100644 --- a/docs/api/Overview.md +++ b/docs/api/Overview.md @@ -1,12 +1,12 @@ ### Nominatim API -Nominatim indexes named (or numbered) features with the OSM data set and a subset of other unnamed features (pubs, hotels, churches, etc). +Nominatim indexes named (or numbered) features within the OpenStreetMap (OSM) dataset and a subset of other unnamed features (pubs, hotels, churches, etc). Its API has the following endpoints for querying the data: * __[/search](Search.md)__ - search OSM objects by name or type * __[/reverse](Reverse.md)__ - search OSM object by their location - * __[/lookup](Lookup.md)__ - look up address details for OSM objects by thier ID + * __[/lookup](Lookup.md)__ - look up address details for OSM objects by their ID * __/status__ - query the status of the server * __/deletable__ - list objects that have been deleted in OSM but are held back in Nominatim in case the deletion was accidental diff --git a/docs/api/Reverse.md b/docs/api/Reverse.md index ae368e1c..22e01331 100644 --- a/docs/api/Reverse.md +++ b/docs/api/Reverse.md @@ -34,7 +34,7 @@ See [Place Output Formats](Output.md) for details on each format. (Default: html * `json_callback=` -Wrap json output in a callback function (JSONP) i.e. `()`. +Wrap json output in a callback function ([JSONP](https://en.wikipedia.org/wiki/JSONP)) i.e. `()`. Only has an effect for JSON output formats. ### Output details @@ -69,7 +69,7 @@ comma-separated list of language codes. * `zoom=[0-18]` -Level of detail required for the address. This is a number that corresponds +Level of detail required for the address. Default: 18. This is a number that corresponds roughly to the zoom level used in map frameworks like Leaflet.js, Openlayers etc. In terms of address details the zoom levels are as follows: diff --git a/docs/api/Search.md b/docs/api/Search.md index ab702379..4b9d773c 100644 --- a/docs/api/Search.md +++ b/docs/api/Search.md @@ -5,10 +5,9 @@ Nominatim supports structured as well as free-form search queries. The search query may also contain [special phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases) -which are tranlated into specific OpenStreetMap(OSM) tags (e.g. Pub => amenity=pub). -Note that this only limits the items to be found. It is not suited to return complete -lists of OSM objects of a specific type. -Use [Overpass API](https://overpass-api.de/) for that. +which are translated into specific OpenStreetMap (OSM) tags (e.g. Pub => `amenity=pub`). +Note that this only limits the items to be found, it's not suited to return complete +lists of OSM objects of a specific type. For those use [Overpass API](https://overpass-api.de/). ## Parameters @@ -30,22 +29,20 @@ In this form, the query may be given through two different sets of parameters: * `q=` Free-form query string to search for. - Free-form queries are processed first left to right and then right to - left if that fails. So you may search for + Free-form queries are processed first left-to-right and then right-to-left if that fails. So you may search for [pilkington avenue, birmingham](//nominatim.openstreetmap.org/search?q=pilkington+avenue,birmingham) as well as for [birmingham, pilkington avenue](//nominatim.openstreetmap.org/search?q=birmingham,+pilkington+avenue). - Commas are optional, but improve performance by reducing the complexity - of the search. + Commas are optional, but improve performance by reducing the complexity of the search. * `street= ` - `city=` - `county=` - `state=` - `country=` - `postalcode=` +* `city=` +* `county=` +* `state=` +* `country=` +* `postalcode=` - Alternative query string format for structured requests. + Alternative query string format split into several parameters for structured requests. Structured requests are faster but are less robust against alternative OSM tagging schemas. **Do not combine with** `q=` **parameter**. @@ -59,7 +56,7 @@ See [Place Output Formats](Output.md) for details on each format. (Default: html * `json_callback=` -Wrap json output in a callback function (JSONP) i.e. `()`. +Wrap json output in a callback function ([JSONP](https://en.wikipedia.org/wiki/JSONP)) i.e. `()`. Only has an effect for JSON output formats. ### Output details @@ -86,7 +83,7 @@ language variants, references, operator and brand. (Default: 0) * `accept-language=` Preferred language order for showing search results, overrides the value -specified in the "Accept-Language" HTTP header. +specified in the ["Accept-Language" HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language). Either use a standard RFC2616 accept-language string or a simple comma-separated list of language codes. @@ -109,7 +106,7 @@ the search to return other, less accurate, matches (if possible). * `limit=` -Limit the number of returned results. (Default: 10) +Limit the number of returned results. (Default: 10, Maximum: 50) * `viewbox=,,,` @@ -121,9 +118,9 @@ are accepted in any order as long as they span a real box. * `bounded=[0|1]` When a viewbox is given, restrict the result to items contained with that -viewbox (see above). When `viewbox` and `bounded` are given, an amenity +viewbox (see above). When `viewbox` and `bounded=1` are given, an amenity only search is allowed. In this case, give the special keyword for the -amenity in squaer brackets, e.g. `[pub]`. (Default: 0) +amenity in square brackets, e.g. `[pub]`. (Default: 0) ### Polygon output -- 2.43.2