Skip to content

Commit 3900552

Browse files
Update SnappedPoint.yml (#398)
* Update SnappedPoint.yml Clarifying that the Nearest Roads API may send several objects for the same index. This differs from the Snap to Roads API but isn't outlined here. See nearest roads vs snap to roads: https://roads.googleapis.com/v1/nearestRoads?points=58.3441718,12.3007768&key=REDACTED https://roads.googleapis.com/v1/snapToRoads?path=58.3441718,12.3007768&key=REDACTED * Update nearestRoads.yml * Update NearestRoadsResponse.yml * chore: update dist folder [skip ci] * Reverted changes to /dist Co-authored-by: googlemaps-bot <googlemaps-bot@google.com>
1 parent e407bb0 commit 3900552

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

specification/paths/nearestRoads.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ servers:
1616
- url: https://roads.googleapis.com
1717
tags:
1818
- Roads API
19-
description: This service returns individual road segments for a given set of GPS coordinates. This services takes up to 100 GPS points and returns the closest road segment for each point. The points passed do not need to be part of a continuous path.
19+
description: This service returns individual road segments for a given set of GPS coordinates. This services takes up to 100 GPS points and returns the closest road segments for each point. The points passed do not need to be part of a continuous path.
2020
parameters:
2121
- "$ref": "../parameters/nearestRoads/points.yml"
2222
responses:

specification/schemas/NearestRoadsResponse.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type: object
1616
title: NearestRoadsResponse
1717
properties:
1818
snappedPoints:
19-
description: An array of snapped points.
19+
description: An array of snapped points. Sometimes containing several snapped points for the same point with differing placeId or location.
2020
type: array
2121
items:
2222
$ref: "./SnappedPoint.yml"

specification/schemas/SnappedPoint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ properties:
1919
location:
2020
$ref: "./LatitudeLongitudeLiteral.yml"
2121
originalIndex:
22-
description: An integer that indicates the corresponding value in the original request. Each value in the request should map to a snapped value in the response. However, if you've set interpolate=true, then it's possible that the response will contain more coordinates than the request. Interpolated values will not have an `originalIndex`. These values are indexed from `0`, so a point with an originalIndex of `4` will be the snapped value of the 5th latitude/longitude passed to the path parameter.
22+
description: An integer that indicates the corresponding value in the original request. Each value in the request should map to a snapped value in the response. However, if you've set interpolate=true or if you're using nearest roads, then it's possible that the response will contain more coordinates than the request. Interpolated values will not have an `originalIndex`. These values are indexed from `0`, so a point with an originalIndex of `4` will be the snapped value of the 5th latitude/longitude passed to the path parameter. Nearest Roads points may contain several points for single coordinates with differing location or placeId.
2323
type: number
2424
placeId:
2525
description: A unique identifier for a place. All place IDs returned by the Roads API correspond to road segments.

0 commit comments

Comments
 (0)