From 3900552f8117d334194e3ba84d1a84a635871abb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nora=20S=C3=B6derlund?= Date: Mon, 12 Dec 2022 20:30:54 +0000 Subject: [PATCH] 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 --- specification/paths/nearestRoads.yml | 2 +- specification/schemas/NearestRoadsResponse.yml | 2 +- specification/schemas/SnappedPoint.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/paths/nearestRoads.yml b/specification/paths/nearestRoads.yml index e5df9a5a..5c9cc24b 100644 --- a/specification/paths/nearestRoads.yml +++ b/specification/paths/nearestRoads.yml @@ -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: diff --git a/specification/schemas/NearestRoadsResponse.yml b/specification/schemas/NearestRoadsResponse.yml index dc442ecd..692ddf91 100644 --- a/specification/schemas/NearestRoadsResponse.yml +++ b/specification/schemas/NearestRoadsResponse.yml @@ -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" diff --git a/specification/schemas/SnappedPoint.yml b/specification/schemas/SnappedPoint.yml index 8f8ecf1b..12eb2ce7 100644 --- a/specification/schemas/SnappedPoint.yml +++ b/specification/schemas/SnappedPoint.yml @@ -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.