Skip to content

Commit 5dbc2b2

Browse files
Google APIscopybara-github
authored andcommitted
feat!: moved speed in SpeedReadingInterval into a oneof speed_type, this is a breaking change for Go client libraries
docs: update proto comments to contain concrete references to other proto messages PiperOrigin-RevId: 518398192
1 parent eb21b87 commit 5dbc2b2

19 files changed

Lines changed: 102 additions & 82 deletions

google/maps/routing/v2/fallback_info.proto

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -62,11 +62,12 @@ enum FallbackRoutingMode {
6262
// Not used.
6363
FALLBACK_ROUTING_MODE_UNSPECIFIED = 0;
6464

65-
// Indicates the "TRAFFIC_UNAWARE" routing mode was used to compute the
66-
// response.
65+
// Indicates the `TRAFFIC_UNAWARE` [google.maps.routing.v2.RoutingPreference]
66+
// was used to compute the response.
6767
FALLBACK_TRAFFIC_UNAWARE = 1;
6868

69-
// Indicates the "TRAFFIC_AWARE" routing mode was used to compute the
70-
// response.
69+
// Indicates the `TRAFFIC_AWARE`
70+
// [RoutingPreference][google.maps.routing.v2.RoutingPreference] was used to
71+
// compute the response.
7172
FALLBACK_TRAFFIC_AWARE = 2;
7273
}

google/maps/routing/v2/geocoding_results.proto

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ option objc_class_prefix = "GMRV2";
2828
option php_namespace = "Google\\Maps\\Routing\\V2";
2929
option ruby_package = "Google::Maps::Routing::V2";
3030

31-
// Contains GeocodedWaypoints for origin, destination and intermediate
32-
// waypoints. Only populated for address waypoints.
31+
// Contains [GeocodedWaypoints][google.maps.routing.v2.GeocodedWaypoint] for
32+
// origin, destination and intermediate waypoints. Only populated for address
33+
// waypoints.
3334
message GeocodingResults {
3435
// Origin geocoded waypoint.
3536
GeocodedWaypoint origin = 1;

google/maps/routing/v2/location.proto

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -38,6 +38,7 @@ message Location {
3838
// This value is used to specify the side of the road to use for pickup and
3939
// drop-off. Heading values can be from 0 to 360, where 0 specifies a heading
4040
// of due North, 90 specifies a heading of due East, etc. You can use this
41-
// field only for `DRIVE` and `TWO_WHEELER` travel modes.
41+
// field only for `DRIVE` and `TWO_WHEELER`
42+
// [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
4243
google.protobuf.Int32Value heading = 2;
4344
}

google/maps/routing/v2/maneuver.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

google/maps/routing/v2/navigation_instruction.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

google/maps/routing/v2/polyline.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

google/maps/routing/v2/route.proto

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -43,12 +43,12 @@ message Route {
4343
repeated RouteLabel route_labels = 13;
4444

4545
// A collection of legs (path segments between waypoints) that make-up the
46-
// route. Each leg corresponds to the trip between two non-`via` Waypoints.
47-
// For example, a route with no intermediate waypoints has only one leg. A
48-
// route that includes one non-`via` intermediate waypoint has two legs. A
49-
// route that includes one `via` intermediate waypoint has one leg. The order
50-
// of the legs matches the order of Waypoints from `origin` to `intermediates`
51-
// to `destination`.
46+
// route. Each leg corresponds to the trip between two non-`via`
47+
// [Waypoints][google.maps.routing.v2.Waypoint]. For example, a route with no
48+
// intermediate waypoints has only one leg. A route that includes one
49+
// non-`via` intermediate waypoint has two legs. A route that includes one
50+
// `via` intermediate waypoint has one leg. The order of the legs matches the
51+
// order of Waypoints from `origin` to `intermediates` to `destination`.
5252
repeated RouteLeg legs = 1;
5353

5454
// The travel distance of the route, in meters.
@@ -188,8 +188,9 @@ message RouteLeg {
188188
RouteLegTravelAdvisory travel_advisory = 8;
189189
}
190190

191-
// Encapsulates a segment of a `RouteLeg`. A step corresponds to a single
192-
// navigation instruction. Route legs are made up of steps.
191+
// Encapsulates a segment of a [RouteLeg][google.maps.routing.v2.RouteLeg]. A
192+
// step corresponds to a single navigation instruction. Route legs are made up
193+
// of steps.
193194
message RouteLegStep {
194195
// The travel distance of this step, in meters. In some circumstances, this
195196
// field might not have a value.

google/maps/routing/v2/route_label.proto

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -26,8 +26,8 @@ option objc_class_prefix = "GMRV2";
2626
option php_namespace = "Google\\Maps\\Routing\\V2";
2727
option ruby_package = "Google::Maps::Routing::V2";
2828

29-
// Labels for the `Route` that are useful to identify specific properties
30-
// of the route to compare against others.
29+
// Labels for the [Route][google.maps.routing.v2.Route] that are useful to
30+
// identify specific properties of the route to compare against others.
3131
enum RouteLabel {
3232
// Default - not used.
3333
ROUTE_LABEL_UNSPECIFIED = 0;
@@ -36,8 +36,9 @@ enum RouteLabel {
3636
DEFAULT_ROUTE = 1;
3737

3838
// An alternative to the default "best" route. Routes like this will be
39-
// returned when `ComputeRoutesRequest.compute_alternative_routes` is
40-
// specified.
39+
// returned when
40+
// [compute_alternative_routes][google.maps.routing.v2.ComputeRoutesRequest.compute_alternative_routes]
41+
// is specified.
4142
DEFAULT_ROUTE_ALTERNATE = 2;
4243

4344
// Fuel efficient route. Routes labeled with this value are determined to be

google/maps/routing/v2/route_modifiers.proto

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -34,22 +34,24 @@ option ruby_package = "Google::Maps::Routing::V2";
3434
message RouteModifiers {
3535
// Specifies whether to avoid toll roads where reasonable. Preference will be
3636
// given to routes not containing toll roads. Applies only to the `DRIVE` and
37-
// `TWO_WHEELER` travel modes.
37+
// `TWO_WHEELER` [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
3838
bool avoid_tolls = 1;
3939

4040
// Specifies whether to avoid highways where reasonable. Preference will be
4141
// given to routes not containing highways. Applies only to the `DRIVE` and
42-
// `TWO_WHEELER` travel modes.
42+
// `TWO_WHEELER` [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
4343
bool avoid_highways = 2;
4444

4545
// Specifies whether to avoid ferries where reasonable. Preference will be
4646
// given to routes not containing travel by ferries.
47-
// Applies only to the `DRIVE` and`TWO_WHEELER` travel modes.
47+
// Applies only to the `DRIVE` and`TWO_WHEELER`
48+
// [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
4849
bool avoid_ferries = 3;
4950

5051
// Specifies whether to avoid navigating indoors where reasonable. Preference
5152
// will be given to routes not containing indoor navigation.
52-
// Applies only to the `WALK` travel mode.
53+
// Applies only to the `WALK`
54+
// [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
5355
bool avoid_indoor = 4;
5456

5557
// Specifies the vehicle information.
@@ -59,6 +61,7 @@ message RouteModifiers {
5961
// If toll passes are provided, the API tries to return the pass price. If
6062
// toll passes are not provided, the API treats the toll pass as unknown and
6163
// tries to return the cash price.
62-
// Applies only to the DRIVE and TWO_WHEELER travel modes.
64+
// Applies only to the `DRIVE` and `TWO_WHEELER`
65+
// [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
6366
repeated TollPass toll_passes = 6;
6467
}

google/maps/routing/v2/route_travel_mode.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -27,8 +27,8 @@ option php_namespace = "Google\\Maps\\Routing\\V2";
2727
option ruby_package = "Google::Maps::Routing::V2";
2828

2929
// A set of values used to specify the mode of travel.
30-
// NOTE: WALK, BICYCLE, and TWO_WHEELER routes are in beta and might sometimes
31-
// be missing clear sidewalks, pedestrian paths, or bicycling paths.
30+
// NOTE: `WALK`, `BICYCLE`, and `TWO_WHEELER` routes are in beta and might
31+
// sometimes be missing clear sidewalks, pedestrian paths, or bicycling paths.
3232
// You must display this warning to the user for all walking, bicycling, and
3333
// two-wheel routes that you display in your app.
3434
enum RouteTravelMode {

0 commit comments

Comments
 (0)