Skip to content

Commit

Permalink
Update SnappedPoint.yml (#398)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
nora-soderlund and googlemaps-bot authored Dec 12, 2022
1 parent e407bb0 commit 3900552
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion specification/paths/nearestRoads.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ servers:
- url: https://roads.googleapis.com
tags:
- Roads API
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.
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.
parameters:
- "$ref": "../parameters/nearestRoads/points.yml"
responses:
Expand Down
2 changes: 1 addition & 1 deletion specification/schemas/NearestRoadsResponse.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ type: object
title: NearestRoadsResponse
properties:
snappedPoints:
description: An array of snapped points.
description: An array of snapped points. Sometimes containing several snapped points for the same point with differing placeId or location.
type: array
items:
$ref: "./SnappedPoint.yml"
2 changes: 1 addition & 1 deletion specification/schemas/SnappedPoint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ properties:
location:
$ref: "./LatitudeLongitudeLiteral.yml"
originalIndex:
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.
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.
type: number
placeId:
description: A unique identifier for a place. All place IDs returned by the Roads API correspond to road segments.
Expand Down

0 comments on commit 3900552

Please sign in to comment.