more library documentation

[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..dae560b2929e8a19a91207f685e264e9ae190fe1 100644 (file)
--- a/docs/library/Input-Parameter-Types.md
+++ b/docs/library/Input-Parameter-Types.md
@@ -1,28 +1,51 @@
-# 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
 
 
 ## Place identification
 

+The [details](NominatimAPI.md#nominatim.api.core.NominatimAPI.details) and
+[lookup](NominatimAPI.md#nominatim.api.core.NominatimAPI.lookup) functions
+require references to places in the database. Below are listed the possible
+types for place identification. All types are dataclasses.
+
+### PlaceID
+

 ::: nominatim.api.PlaceID
     options:
         heading_level: 6
 
 ::: nominatim.api.PlaceID
     options:
         heading_level: 6
 

+### OsmID
+

 ::: nominatim.api.OsmID
     options:
         heading_level: 6
 
 ::: nominatim.api.OsmID
     options:
         heading_level: 6
 

-## Geometries
+## Geometry types

 
 ::: nominatim.api.GeometryFormat
     options:
         heading_level: 6
 
 ::: nominatim.api.GeometryFormat
     options:
         heading_level: 6

+        members_order: source
+
+## Geometry input
+
+### Point

 
 ::: nominatim.api.Point
     options:
         heading_level: 6
 
 ::: nominatim.api.Point
     options:
         heading_level: 6

+        show_signature_annotations: True
+
+### Bbox

 
 ::: nominatim.api.Bbox
     options:
         heading_level: 6
 
 ::: nominatim.api.Bbox
     options:
         heading_level: 6

+        show_signature_annotations: True
+        members_order: source
+        group_by_category: False

 
 ## Layers
 
 
 ## Layers