From 5be6f8959aee63614c1493a36b96dab438c913ff Mon Sep 17 00:00:00 2001 From: Lev Dragunov Date: Wed, 11 Jan 2017 12:22:54 +0300 Subject: [PATCH] Describe alternatives_count in documentation --- docs/http.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/http.md b/docs/http.md index 18221f66b..f0858f8f7 100644 --- a/docs/http.md +++ b/docs/http.md @@ -298,6 +298,7 @@ The area to search is chosen such that the correct candidate should be considere Each `Waypoint` object has the following additional properties: - `matchings_index`: Index to the `Route` object in `matchings` the sub-trace was matched to. - `waypoint_index`: Index of the waypoint inside the matched route. + - `alternatives_count`: number of routes leading to the destination from this trace point. 1 means there are no other routes reaching destination. Greater values mean that there are different routes available and different route can be selected if you provide more coordinates. - `matchings`: An array of `Route` objects that assemble the trace. Each `Route` object has the following additional properties: - `confidence`: Confidence of the matching. `float` value between 0 and 1. 1 is very confident that the matching is correct.