From 4113169e0cc61896fe0996fab566fa8a30abb585 Mon Sep 17 00:00:00 2001 From: Peter Date: Sat, 21 Sep 2024 11:16:07 +0200 Subject: [PATCH] Update api-doc.md --- docs/web/api-doc.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/web/api-doc.md b/docs/web/api-doc.md index c80dd37520..b60169f3f6 100644 --- a/docs/web/api-doc.md +++ b/docs/web/api-doc.md @@ -43,13 +43,9 @@ All official parameters are shown in the following table points_encoded | true | If `false` the coordinates in `point` and `snapped_waypoints` are returned as array using the order [lon,lat,elevation] for every point. If `true` the coordinates will be encoded as string leading to less bandwidth usage. You'll need a special handling for the decoding of this string on the client-side. We provide open source code in [Java](https://github.com/graphhopper/graphhopper/blob/d70b63660ac5200b03c38ba3406b8f93976628a6/web/src/main/java/com/graphhopper/http/WebHelper.java#L43) and [JavaScript](https://github.com/graphhopper/graphhopper/blob/d70b63660ac5200b03c38ba3406b8f93976628a6/web/src/main/webapp/js/ghrequest.js#L139). It is especially important to use no 3rd party client if you set `elevation=true`! points_encoded_encoded |1e5| Used in case `points_encoded=true` to encode the `points` string into an array of coordinates. debug | false | If true, the output will be formatted. - calc_points | true | If the points for the route should be calculated at all printing out only distance and time. - point_hint | - | Optional parameter. When finding the closest road location for GPS coordinates provided in the `point` parameter this hint prefers a road with a similar name. E.g. if there is an address with two close roads you can control which street is preferred. Only include the road name and not the house number to improve the name matching quality. - snap_prevention | - | Optional parameter. 'Snapping' is the process of finding the closest road location for GPS coordinates provided in the `point` parameter. The `snap_prevention` parameter allows you to prevent snapping to specific types of roads. For example, if `snap_prevention` is set to bridge, the routing engine will avoid snapping to a bridge, even if it is the closest road for the given `point`. Current supported values: `motorway`, `trunk`, `ferry`, `tunnel`, `bridge` and `ford`. Multiple values are specified like `snap_prevention=ferry&snap_prevention=motorway`. Note that once snapped the routing algorithm can still route over bridges (or the other values). To avoid this you need to use the `custom_model`. - details | - | Optional parameter. You can request additional details for the route: `average_speed`, `street_name`, `edge_id`, `road_class`, `road_environment`, `max_speed` and `time` (and see which other values are configured in `graph.encoded_values`). Multiple values are specified like `details=average_speed&details=time`. The returned format for one detail segment is `[fromRef, toRef, value]`. The `ref` references the points of the response. Value can also be `null` if the property does not exist for one detail segment. curbside | any | Optional parameter applicable to edge-based routing only. It specifies on which side a query point should be relative to the driver when she leaves/arrives at a start/target/via point. Possible values: right, left, any. Specify for every point parameter. See similar heading parameter. curbside_strictness| strict| Optional parameter. If it is set to "strict" there will be an exception in case the curbside parameters cannot be fulfilled (e.g. specifying the wrong side for one-ways). If you don't want this use "soft".