Merge pull request #3515 from lonvia/custom-result-formatting

[nominatim.git] / docs / library / Input-Parameter-Types.md

diff --git a/docs/library/Input-Parameter-Types.md b/docs/library/Input-Parameter-Types.md
index e6b5138ca5eda13115b8de8c4d85898f1604eec4..d27bc96ff9d78613a96553b0b0dcb1a45d5fa516 100644 (file)
--- a/docs/library/Input-Parameter-Types.md
+++ b/docs/library/Input-Parameter-Types.md
@@ -1,33 +1,60 @@
-# Input parameters
+# Input Parameter Types
+
+This page describes in more detail some of the input parameter types used
+in the query functions of the API object.
 
 ## Place identification
 
-::: nominatim.api.PlaceID
+The [details](NominatimAPI.md#nominatim_api.NominatimAPI.details) and
+[lookup](NominatimAPI.md#nominatim_api.NominatimAPI.lookup) functions
+require references to places in the database. Below the possible
+types for place identification are listed. All types are dataclasses.
+
+### PlaceID
+
+::: nominatim_api.PlaceID
     options:
         heading_level: 6
 
-::: nominatim.api.OsmID
+### OsmID
+
+::: nominatim_api.OsmID
     options:
         heading_level: 6
 
-## Geometries
+## Geometry types
 
-::: nominatim.api.GeometryFormat
+::: nominatim_api.GeometryFormat
     options:
         heading_level: 6
+        members_order: source
+
+## Geometry input
+
+### Point
 
-::: nominatim.api.Point
+::: nominatim_api.Point
     options:
         heading_level: 6
+        show_signature_annotations: True
 
-::: nominatim.api.Bbox
+### Bbox
+
+::: nominatim_api.Bbox
     options:
         heading_level: 6
+        show_signature_annotations: True
+        members_order: source
+        group_by_category: False
 
 ## Layers
 
-::: nominatim.api.DataLayer
-    options:
-        heading_level: 6
+Layers allow to restrict the search result to thematic groups. This is
+orthogonal to restriction by address ranks, which groups places by their
+geographic extent.
 
 
+::: nominatim_api.DataLayer
+    options:
+        heading_level: 6
+        members_order: source