From 53011755a2f49d805597cde122f880d73c098623 Mon Sep 17 00:00:00 2001 From: "Daniel J. Hofmann" Date: Mon, 6 Feb 2017 15:57:00 +0100 Subject: [PATCH] Removes distance field from Waypoint docs Waypoint objects have - name - location - hint fields. The only API adding `distance` to waypoints is the Nearest plugin. And it documents this behavior independently. The docs are wrong here from what I can tell. See: - https://github.com/Project-OSRM/osrm-backend/blob/5.5/src/engine/api/json_factory.cpp#L290-L297 - https://github.com/Project-OSRM/osrm-backend/blob/5.5/include/engine/api/nearest_api.hpp#L37-L44 --- docs/http.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/http.md b/docs/http.md index 57104b3b2..1a6fdc95b 100644 --- a/docs/http.md +++ b/docs/http.md @@ -721,7 +721,6 @@ Object used to describe waypoint on a route. - `name` Name of the street the coordinate snapped to - `location` Array that contains the `[longitude, latitude]` pair of the snapped coordinate -- `distance` The distance of the snapped point from the original - `hint` Unique internal identifier of the segment (ephemeral, not constant over data updates) This can be used on subsequent request to significantly speed up the query and to connect multiple services. E.g. you can use the `hint` value obtained by the `nearest` query as `hint` values for `route` inputs.