Merge pull request #3521 from lonvia/make-requests-optional

[nominatim.git] / docs / api / Search.md

diff --git a/docs/api/Search.md b/docs/api/Search.md
index 20a35b0853a4cc2c03d0a33ce271c08366fb1d55..f1b4b8a09c0458b18e2d2bde13acb6f78ff67062 100644 (file)
--- a/docs/api/Search.md
+++ b/docs/api/Search.md
@@ -152,7 +152,7 @@ as the ["Accept-Language" HTTP header](https://developer.mozilla.org/en-US/docs/
     results when using Nominatim in the browser versus in a command-line tool
     like wget or curl. The command-line tools
     usually don't send any Accept-Language header, prompting Nominatim
     results when using Nominatim in the browser versus in a command-line tool
     like wget or curl. The command-line tools
     usually don't send any Accept-Language header, prompting Nominatim

-    to show results in the local language. Browsers on the contratry always
+    to show results in the local language. Browsers on the contrary always

     send the currently chosen browser language.
 
 ### Result restriction
     send the currently chosen browser language.
 
 ### Result restriction


@@ -165,7 +165,7 @@ results and thus give a preference to some results over others.
 |-----------| ----- | ------- |
 | countrycodes | comma-separated list of country codes | _unset_ |
 
 |-----------| ----- | ------- |
 | countrycodes | comma-separated list of country codes | _unset_ |
 

-Filer that limits the search results to one or more countries.
+Filter that limits the search results to one or more countries.

 The country code must be the
 [ISO 3166-1alpha2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code
 of the country, e.g. `gb` for the United Kingdom, `de` for Germany.
 The country code must be the
 [ISO 3166-1alpha2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code
 of the country, e.g. `gb` for the United Kingdom, `de` for Germany.


@@ -179,15 +179,17 @@ also excluded when the filter is set.
     This parameter should not be confused with the 'country' parameter of
     the structured query. The 'country' parameter contains a search term
     and will be handled with some fuzziness. The `countrycodes` parameter
     This parameter should not be confused with the 'country' parameter of
     the structured query. The 'country' parameter contains a search term
     and will be handled with some fuzziness. The `countrycodes` parameter

-    is a hard filter and as such should be prefered. Having both parameters
+    is a hard filter and as such should be preferred. Having both parameters

     in the same query will work. If the parameters contradict each other,
     the search will come up empty.
 
 | Parameter | Value | Default |
 |-----------| ----- | ------- |
     in the same query will work. If the parameters contradict each other,
     the search will come up empty.
 
 | Parameter | Value | Default |
 |-----------| ----- | ------- |

-| layers    | comma-separated list of: `address`, `poi`, `railway`, `natural`, `manmade` | _unset_ (no restriction) |
+| layer     | comma-separated list of: `address`, `poi`, `railway`, `natural`, `manmade` | _unset_ (no restriction) |

 
 

-The layers filter allows to select places by themes.
+**`[Python-only]`**
+
+The layer filter allows to select places by themes.

 
 The `address` layer contains all places that make up an address:
 address points with house numbers, streets, inhabited places (suburbs, villages,
 
 The `address` layer contains all places that make up an address:
 address points with house numbers, streets, inhabited places (suburbs, villages,


@@ -201,7 +203,7 @@ The `railway` layer includes railway infrastructure like tracks.
 Note that in Nominatim's standard configuration, only very few railway
 features are imported into the database.
 
 Note that in Nominatim's standard configuration, only very few railway
 features are imported into the database.
 

-The `natural` layer collects feautures like rivers, lakes and mountains. While
+The `natural` layer collects features like rivers, lakes and mountains while

 the `manmade` layer functions as a catch-all for features not covered by the
 other layers.
 
 the `manmade` layer functions as a catch-all for features not covered by the
 other layers.
 


@@ -215,7 +217,7 @@ the 'state', 'country' or 'city' part of an address. A featureType of
 settlement selects any human inhabited feature from 'state' down to
 'neighbourhood'.
 
 settlement selects any human inhabited feature from 'state' down to
 'neighbourhood'.
 

-When featureType ist set, then results are automatically restricted
+When featureType is set, then results are automatically restricted

 to the address layer (see above).
 
 !!! tip
 to the address layer (see above).
 
 !!! tip


@@ -225,7 +227,7 @@ to the address layer (see above).
 
 | Parameter | Value | Default |
 |-----------| ----- | ------- |
 
 | Parameter | Value | Default |
 |-----------| ----- | ------- |

-| exclude_place_ids | comma-separeted list of place ids |
+| exclude_place_ids | comma-separated list of place ids |

 
 If you do not want certain OSM objects to appear in the search
 result, give a comma separated list of the `place_id`s you want to skip.
 
 If you do not want certain OSM objects to appear in the search
 result, give a comma separated list of the `place_id`s you want to skip.


@@ -246,7 +248,7 @@ box. `x` is longitude, `y` is latitude.
 | bounded   | 0 or 1 | 0       |
 
 When set to 1, then it turns the 'viewbox' parameter (see above) into
 | bounded   | 0 or 1 | 0       |
 
 When set to 1, then it turns the 'viewbox' parameter (see above) into

-a filter paramter, excluding any results outside the viewbox.
+a filter parameter, excluding any results outside the viewbox.

 
 When `bounded=1` is given and the viewbox is small enough, then an amenity-only
 search is allowed. Give the special keyword for the amenity in square
 
 When `bounded=1` is given and the viewbox is small enough, then an amenity-only
 search is allowed. Give the special keyword for the amenity in square


@@ -271,7 +273,7 @@ options can be used at a time.
 |-----------| -----  | ------- |
 | polygon_threshold | floating-point number | 0.0 |
 
 |-----------| -----  | ------- |
 | polygon_threshold | floating-point number | 0.0 |
 

-When one og the polygon_* outputs is chosen, return a simplified version
+When one of the polygon_* outputs is chosen, return a simplified version

 of the output geometry. The parameter describes the
 tolerance in degrees with which the geometry may differ from the original
 geometry. Topology is preserved in the geometry.
 of the output geometry. The parameter describes the
 tolerance in degrees with which the geometry may differ from the original
 geometry. Topology is preserved in the geometry.


@@ -294,7 +296,7 @@ Sometimes you have several objects in OSM identifying the same place or
 object in reality. The simplest case is a street being split into many
 different OSM ways due to different characteristics. Nominatim will
 attempt to detect such duplicates and only return one match. Setting
 object in reality. The simplest case is a street being split into many
 different OSM ways due to different characteristics. Nominatim will
 attempt to detect such duplicates and only return one match. Setting

-this parameter is set to 0 disables this deduplication mechanism and
+this parameter to 0 disables this deduplication mechanism and

 ensures that all results are returned.
 
 | Parameter | Value  | Default |
 ensures that all results are returned.
 
 | Parameter | Value  | Default |