Skip to content

Commit eff4a42

Browse files
boldtrnkarussell
authored andcommitted
Added documentation for street_name entry (graphhopper#951)
1 parent a836a5a commit eff4a42

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/web/api-doc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ paths[0].bbox | The bounding box of the route, format: <br> minLon,
7474
paths[0].snapped_waypoints | This value contains the snapped input points. If `points_encoded=true` or no `points_encoded` parameter was specified then an encoded string will be returned, otherwise an array is returned. See the parameter `points_encoded` for more information.
7575
paths[0].instructions | Contains information about the instructions for this route. The last instruction is always the Finish instruction and takes 0ms and 0meter. Keep in mind that instructions are currently under active development and can sometimes contain misleading information, so, make sure you always show an image of the map at the same time when navigating your users!
7676
paths[0].instructions[0].text | A description what the user has to do in order to follow the route. The language depends on the locale parameter.
77+
paths[0].instructions[0].street_name | The name of the street to turn onto in order to follow the route.
7778
paths[0].instructions[0].distance | The distance for this instruction, in meter
7879
paths[0].instructions[0].time | The duration for this instruction, in ms
7980
paths[0].instructions[0].interval | An array containing the first and the last index (relative to paths[0].points) of the points for this instruction. This is useful to know for which part of the route the instructions are valid.

0 commit comments

Comments
 (0)