From 1e3b56d2153cb31be465bc9c5fb6a11d17b5ed9e Mon Sep 17 00:00:00 2001 From: Emily Love Watson Date: Tue, 2 Sep 2025 11:58:29 -0500 Subject: [PATCH] Some docs for the entrances output --- docs/api/Details.md | 7 +++++++ docs/api/Lookup.md | 6 ++++++ docs/api/Output.md | 32 +++++++++++++++++++++++++++----- docs/api/Reverse.md | 6 ++++++ docs/api/Search.md | 6 ++++++ 5 files changed, 52 insertions(+), 5 deletions(-) diff --git a/docs/api/Details.md b/docs/api/Details.md index b836efd3..ddd97786 100644 --- a/docs/api/Details.md +++ b/docs/api/Details.md @@ -105,6 +105,13 @@ grouped by type. Include geometry of result. +| Parameter | Value | Default | +|-----------| ----- | ------- | +| entrances | 0 or 1 | 0 | + +When set to 1, include the tagged entrances in the result. + + ### Language of results | Parameter | Value | Default | diff --git a/docs/api/Lookup.md b/docs/api/Lookup.md index bed01275..b3f39a43 100644 --- a/docs/api/Lookup.md +++ b/docs/api/Lookup.md @@ -77,6 +77,12 @@ that is available in the database, e.g. wikipedia link, opening hours. When set to 1, include a full list of names for the result. These may include language variants, older names, references and brand. +| Parameter | Value | Default | +|-----------| ----- | ------- | +| entrances | 0 or 1 | 0 | + +When set to 1, include the tagged entrances in the result. + ### Language of results diff --git a/docs/api/Output.md b/docs/api/Output.md index a5ec933e..4d93627b 100644 --- a/docs/api/Output.md +++ b/docs/api/Output.md @@ -60,6 +60,8 @@ The possible fields are: * `namedetails` - dictionary with full list of available names including ref etc. * `geojson`, `svg`, `geotext`, `geokml` - full geometry (only with the appropriate `polygon_*` parameter) + * `entrances` - array of objects representing tagged entrances for the object, or + null if none are found (only with `entrances=1`) ## JSONv2 @@ -87,6 +89,8 @@ The properties object has the following fields: * `extratags` - dictionary with additional useful tags like `website` or `maxspeed` (only with `extratags=1`) * `namedetails` - dictionary with full list of available names including ref etc. + * `entrances` - array of objects representing tagged entrances for the object, or + null if none are found (only with `entrances=1`) Use `polygon_geojson` to output the full geometry of the object instead of the centroid. @@ -110,6 +114,8 @@ The following feature attributes are implemented: * `admin` - list of localised names of administrative boundaries (only with `addressdetails=1`) * `extra` - dictionary with additional useful tags like `website` or `maxspeed` (only with `extratags=1`) + * `entrances` - array of objects representing tagged entrances for the object, or + null if none are found (only with `entrances=1`) Use `polygon_geojson` to output the full geometry of the object instead @@ -162,8 +168,8 @@ The place information can be found in the `result` element. The attributes of th The full address of the result can be found in the content of the `result` element as a comma-separated list. -Additional information requested with `addressdetails=1`, `extratags=1` and -`namedetails=1` can be found in extra elements. +Additional information requested with `addressdetails=1`, `extratags=1`, +`namedetails=1`, and `entrances=1` can be found in extra elements. ### Search and Lookup @@ -224,9 +230,9 @@ be more than one. The attributes of that element contain: When `addressdetails=1` is requested, the localised address parts appear as subelements with the type of the address part. -Additional information requested with `extratags=1` and `namedetails=1` can -be found in extra elements as sub-element of `extratags` and `namedetails` -respectively. +Additional information requested with `extratags=1`, `namedetails=1`, and +`entrances=1` can be found in extra elements as sub-element of `extratags`, +`namedetails`, and `entrances` respectively. ## Notes on field values @@ -303,3 +309,19 @@ with a designation label. Per default the following labels may appear: They roughly correspond to the classification of the OpenStreetMap data according to either the `place` tag or the main key of the object. + +### entrances + +Entrance details in the xml and json formats return the latitude and longitude +of the entrance, the osm node ID, the [type of +entrance](https://wiki.openstreetmap.org/wiki/Key:entrance), and any extra tags +associated with the entrance node. + + * osm_id + * type + * lat + * lon + * extratags + +They roughly correspond to the classification of the OpenStreetMap data +according to either the `place` tag or the main key of the object. diff --git a/docs/api/Reverse.md b/docs/api/Reverse.md index e646818f..2963c24b 100644 --- a/docs/api/Reverse.md +++ b/docs/api/Reverse.md @@ -98,6 +98,12 @@ that is available in the database, e.g. wikipedia link, opening hours. When set to 1, include a full list of names for the result. These may include language variants, older names, references and brand. +| Parameter | Value | Default | +|-----------| ----- | ------- | +| entrances | 0 or 1 | 0 | + +When set to 1, include the tagged entrances in the result. + ### Language of results diff --git a/docs/api/Search.md b/docs/api/Search.md index 3c9a7148..78852502 100644 --- a/docs/api/Search.md +++ b/docs/api/Search.md @@ -136,6 +136,12 @@ that is available in the database, e.g. wikipedia link, opening hours. When set to 1, include a full list of names for the result. These may include language variants, older names, references and brand. +| Parameter | Value | Default | +|-----------| ----- | ------- | +| entrances | 0 or 1 | 0 | + +When set to 1, include the tagged entrances in the result. + ### Language of results -- 2.39.5