Skip to content

Commit dd999e1

Browse files
ghoshkajTheMarex
authored andcommitted
Update http.md
Clarify where optional rotary properties will be added
1 parent 69c54be commit dd999e1

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/http.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -576,6 +576,8 @@ step.
576576
- `mode`: A string signifying the mode of transportation.
577577
- `maneuver`: A `StepManeuver` object representing the maneuver.
578578
- `intersections`: A list of `Intersection` objects that are passed along the segment, the very first belonging to the StepManeuver
579+
- `rotary_name`: The name for the rotary. Optionally included, if the step is a rotary and a rotary name is available.
580+
- `rotary_pronunciation`: The pronunciation hint of the rotary name. Optionally included, if the step is a rotary and a rotary pronunciation is available.
579581

580582
#### Example
581583

@@ -630,7 +632,7 @@ step.
630632
- `bearing_after`: The clockwise angle from true north to the
631633
direction of travel immediately after the maneuver. Range 0-359.
632634
- `type` A string indicating the type of maneuver. **new identifiers might be introduced without API change**
633-
Types unknown to the client should be handled like the `turn` type, the existance of correct `modifier` values is guranteed.
635+
Types unknown to the client should be handled like the `turn` type, the existence of correct `modifier` values is guranteed.
634636

635637
| `type` | Description |
636638
|------------------|--------------------------------------------------------------|
@@ -646,8 +648,8 @@ step.
646648
| `end of road` | road ends in a T intersection turn in direction of `modifier`|
647649
| `use lane` | going straight on a specific lane |
648650
| `continue` | Turn in direction of `modifier` to stay on the same road |
649-
| `roundabout` | traverse roundabout, has additional property `exit` with NR if the roundabout is left. `the modifier specifies the direction of entering the roundabout` |
650-
| `rotary` | a traffic circle. While very similar to a larger version of a roundabout, it does not necessarily follow roundabout rules for right of way. It can offer `rotary_name/rotary_pronunciation` in addition to the `exit` parameter. |
651+
| `roundabout` | traverse roundabout, has additional property `exit` with NR if the roundabout is left. The modifier specifies the direction of entering the roundabout. |
652+
| `rotary` | a traffic circle. While very similar to a larger version of a roundabout, it does not necessarily follow roundabout rules for right of way. It can offer `rotary_name` and/or `rotary_pronunciation` parameters (located in the RouteStep object) in addition to the `exit` parameter (located on the StepManeuver object). |
651653
| `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`. |
652654
| `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 |
653655

0 commit comments

Comments
 (0)