-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Route 2025-01-01 #31929
base: main
Are you sure you want to change the base?
Route 2025-01-01 #31929
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
API change check APIView has identified API level changes in this PR and created following API reviews. |
fd1fb67
to
287212f
Compare
6e965d8
to
aaf533e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved with feedback to update the regiontravelsummary countryRegion field.
8d45243
to
4bd50f3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I love the very detailed descriptions in this API doc!
I left a bunch of mostly minor comments but given this is for a GA version I think it's important to get these sorted as much as possible before release.
specification/maps/data-plane/Route/stable/2025-01-01/route.json
Outdated
Show resolved
Hide resolved
specification/maps/data-plane/Route/stable/2025-01-01/route.json
Outdated
Show resolved
Hide resolved
specification/maps/data-plane/Route/stable/2025-01-01/route.json
Outdated
Show resolved
Hide resolved
"trafficCongestion": { | ||
"$ref": "#/definitions/TrafficCongestionEnum" | ||
}, | ||
"departureTime": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DateTime properties do not seem to have any coherent naming convention.
- DirectionsRequest and RouteMatrixRequest have date-time properties
departAt
andarriveAt
- InputRouteRangeProperties has
departAt
- RoutePathProperties, Leg, and RouteMatrixItemResult have date-time properties
departureTime
andarrivalTime
- RouteOperation has
createdDateTime
andlastActionDateTime
Date-time properties should use a consistent naming convention. The suffix for all these should either be "At" (recommended) or "Time" or "DateTime". Pick one and use it everywhere.
@stevemunk @pbrasil Sharing the Route PR as we will publishing the swagger docs in the next few weeks. |
Data Plane API Specification Update Pull Request
Based on the previous Route Preview API (2024-07-24-preview), the following updates have been added:
Tip
Overwhelmed by all this guidance? See the
Getting help
section at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
/route/directions
,/route:range
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.