Skip to content

Commit

Permalink
Update points.yml
Browse files Browse the repository at this point in the history
Corrected instances of "path" to "points" to match sample, plus removed note which is relevant for the path parameter in snap to roads, but isn't relevant for nearest roads. Buganizer bug: b/263178829
  • Loading branch information
wildwoosig authored Jan 3, 2023
1 parent 3900552 commit f5d8dbc
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions specification/parameters/nearestRoads/points.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@

name: points
description: |
The path to be snapped. The path parameter accepts a list of latitude/longitude pairs. Latitude and longitude values should be separated by commas. Coordinates should be separated by the pipe character: "|". For example: `path=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796`.
<div class="note">Note: The snapping algorithm works best for points that are not too far apart. If you observe odd snapping behavior, try creating paths that have points closer together. To ensure the best snap-to-road quality, you should aim to provide paths on which consecutive pairs of points are within 300m of each other. This will also help in handling any isolated, long jumps between consecutive points caused by GPS signal loss, or noise.</div>
The points to be snapped. The points parameter accepts a list of latitude/longitude pairs. Separate latitude and longitude values with commas. Separate coordinates with the pipe character: "|". For example: `points=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796`.
required: true
in: query
style: pipeDelimited
explode: false
example:
["60.170880,24.942795", "60.170879,24.942796", "60.170877,24.942796"]
schema:
$ref: "../../schemas/LatLngArrayString.yml"
$ref: "../../schemas/LatLngArrayString.yml"

0 comments on commit f5d8dbc

Please sign in to comment.