diff --git a/docs/http.md b/docs/http.md index f8b576c35..165aa5394 100644 --- a/docs/http.md +++ b/docs/http.md @@ -357,7 +357,7 @@ Three input coordinates, `geometry=geojson`, `steps=false`: { "distance": 90.0, "duration": 300.0, - "geometry": {"type": "LineString", "coordinates": [[120., 10.], [120.1, 10.], [120.2, 10.], [120.3, 10.]]}, + "geometry": {"type": "LineString", "coordinates": [[120.0, 10.0], [120.1, 10.0], [120.2, 10.0], [120.3, 10.0]]}, "legs": [ { "distance": 30.0, @@ -410,7 +410,7 @@ With `steps=false` and `annotations=true`: { "distance": 30.0, "duration": 100.0, - "steps": [] + "steps": [], "annotation": { "distance": [5,5,10,5,5], "duration": [15,15,40,15,15], @@ -486,23 +486,23 @@ step. - `type` A string indicating the type of maneuver. **new identifiers might be introduced without API change** Types unknown to the client should be handled like the `turn` type, the existance of correct `modifier` values is guranteed. - | `type` | Description | - |-------------------|--------------------------------------------------------------| - | turn | a basic turn into direction of the `modifier` | - | new name | no turn is taken/possible, but the road name changes. The road can take a turn itself, following `modifier`. | - | depart | indicates the departure of the leg | - | arrive | indicates the destination of the leg | - | merge | merge onto a street (e.g. getting on the highway from a ramp, the `modifier specifies the direction of the merge`) | - | ramp | **Deprecated**. Replaced by `on_ramp` and `off_ramp`. | - | on ramp | take a ramp to enter a highway (direction given my `modifier`) | - | off ramp | take a ramp to exit a highway (direction given my `modifier`) | - | fork | take the left/right side at a fork depending on `modifier` | - | end of road | road ends in a T intersection turn in direction of `modifier`| - | continue | Turn in direction of `modifier` to stay on the same road | - | roundabout | traverse roundabout, has additional field `exit` with NR if the roundabout is left. `the modifier specifies the direction of entering the roundabout` | - | rotary | a larger version of a roundabout, can offer `rotary_name` in addition to the `exit` parameter. | - | roundabout turn | Describes a turn at a small roundabout that should be treated as normal turn. The `modifier` indicates the turn direciton. Example instruction: `At the roundabout turn left`. | - | notification | not an actual turn but a change in the driving conditions. For example the travel mode. If the road takes a turn itself, the `modifier` describes the direction | + | `type` | Description | + |------------------|--------------------------------------------------------------| + | `turn` | a basic turn into direction of the `modifier` | + | `new name` | no turn is taken/possible, but the road name changes. The road can take a turn itself, following `modifier`. | + | `depart` | indicates the departure of the leg | + | `arrive` | indicates the destination of the leg | + | `merge` | merge onto a street (e.g. getting on the highway from a ramp, the `modifier specifies the direction of the merge`) | + | `ramp` | **Deprecated**. Replaced by `on_ramp` and `off_ramp`. | + | `on ramp` | take a ramp to enter a highway (direction given my `modifier`) | + | `off ramp` | take a ramp to exit a highway (direction given my `modifier`) | + | `fork` | take the left/right side at a fork depending on `modifier` | + | `end of road` | road ends in a T intersection turn in direction of `modifier`| + | `continue` | Turn in direction of `modifier` to stay on the same road | + | `roundabout` | traverse roundabout, has additional field `exit` with NR if the roundabout is left. `the modifier specifies the direction of entering the roundabout` | + | `rotary` | a larger version of a roundabout, can offer `rotary_name` in addition to the `exit` parameter. | + | `roundabout turn`| Describes a turn at a small roundabout that should be treated as normal turn. The `modifier` indicates the turn direciton. Example instruction: `At the roundabout turn left`. | + | `notification` | not an actual turn but a change in the driving conditions. For example the travel mode. If the road takes a turn itself, the `modifier` describes the direction | Please note that even though there are `new name` and `notification` instructions, the `mode` and `name` can change between all instructions. They only offer a fallback in case nothing else is to report. @@ -511,14 +511,14 @@ step. | `modifier` | Description | |-------------------|-------------------------------------------| - | uturn | indicates reversal of direction | - | sharp right | a sharp right turn | - | right | a normal turn to the right | - | slight right | a slight turn to the right | - | straight | no relevant change in direction | - | slight left | a slight turn to the left | - | left | a normal turn to the left | - | sharp left | a sharp turn to the left | + | `uturn` | indicates reversal of direction | + | `sharp right` | a sharp right turn | + | `right` | a normal turn to the right | + | `slight right` | a slight turn to the right | + | `straight` | no relevant change in direction | + | `slight left` | a slight turn to the left | + | `left` | a normal turn to the left | + | `sharp left` | a sharp turn to the left | The list of turns without a modifier is limited to: `depart/arrive`. If the source/target location is close enough to the `depart/arrive` location, no modifier will be given. @@ -542,7 +542,7 @@ New properties (potentially depending on `type`) may be introduced in the future ### Lane -A lane give a representation of turn lane at the corresponding turn location. +A `Lane` represents a turn lane at the corresponding turn location. #### Properties @@ -551,14 +551,14 @@ A lane give a representation of turn lane at the corresponding turn location. | `value` | Description | |------------------------|---------------------------------------------------------------------------------------------------------------------------| | `none` | No dedicated indication is shown. | + | `uturn` | An indication signaling the possibility to reverse (i.e. fully bend arrow). | | `sharp right` | An indication indicating a sharp right turn (i.e. strongly bend arrow). | | `right` | An indication indicating a right turn (i.e. bend arrow). | - | `sharp right` | An indication indicating a slight right turn (i.e. slightly bend arrow). | + | `slight right` | An indication indicating a slight right turn (i.e. slightly bend arrow). | | `straight` | No dedicated indication is shown (i.e. straight arrow). | - | `sharp left` | An indication indicating a sharp left turn (i.e. strongly bend arrow). | + | `slight left` | An indication indicating a slight left turn (i.e. slightly bend arrow). | | `left` | An indication indicating a left turn (i.e. bend arrow). | - | `sharp left` | An indication indicating a slight left turn (i.e. slightly bend arrow). | - | `uturn` | An indication signaling the possibility to reverse (i.e. fully bend arrow). | + | `sharp left` | An indication indicating a sharp left turn (i.e. strongly bend arrow). | - `valid`: a boolean flag indicating whether the lane is a valid choice in the current maneuver @@ -566,7 +566,7 @@ A lane give a representation of turn lane at the corresponding turn location. ```json { - "indication": ["left", "straight"], + "indications": ["left", "straight"], "valid": "false" } ```