Skip to content

Route 2025-01-01#31929

Merged
koyasu221b merged 22 commits intomainfrom
users/huangwill/koyasu221b-maps-Route-2025-01-01
Mar 4, 2025
Merged

Route 2025-01-01#31929
koyasu221b merged 22 commits intomainfrom
users/huangwill/koyasu221b-maps-Route-2025-01-01

Conversation

@koyasu221b
Copy link
Copy Markdown
Member

@koyasu221b koyasu221b commented Dec 19, 2024 •
edited
Loading

Data Plane API Specification Update Pull Request

Based on the previous Route Preview API (2024-07-24-preview), the following updates have been added:

  • DrivingSide in Instructions: Included the drivingSide property for instructions in truck mode.
  • Address Property in ManeuverPoint: Added the address property under ManeuverPoint for enhanced location details.
  • OptimizedIndex in Summary: Introduced the optimizedIndex property under summary to reflect optimized routing details.

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.

spec_pr_review_workflow_diagram

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.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

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.

  • Design Document:

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.

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Dec 19, 2024 •
edited
Loading

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Dec 19, 2024 •
edited
Loading

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

@koyasu221b koyasu221b added PublishToCustomers Acknowledgement the changes will be published to Azure customers. DataPlane data-plane and removed DataPlane labels Dec 19, 2024
@azure-sdk
Copy link
Copy Markdown
Collaborator

azure-sdk commented Dec 19, 2024

API change check

APIView has identified API level changes in this PR and created following API reviews.

AsyncBatchManagement-Route

@koyasu221b koyasu221b force-pushed the users/huangwill/koyasu221b-maps-Route-2025-01-01 branch 2 times, most recently from fd1fb67 to 287212f Compare January 10, 2025 01:54
@koyasu221b koyasu221b marked this pull request as ready for review January 15, 2025 16:16
@koyasu221b koyasu221b requested a review from a team as a code owner January 15, 2025 16:16
@koyasu221b koyasu221b requested review from FarazGIS, JeffreyRichter, johanste and mikekistler and removed request for a team January 15, 2025 16:16
@koyasu221b koyasu221b force-pushed the users/huangwill/koyasu221b-maps-Route-2025-01-01 branch 2 times, most recently from 6e965d8 to aaf533e Compare January 21, 2025 01:29
@koyasu221b koyasu221b added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Jan 23, 2025
@koyasu221b koyasu221b mentioned this pull request Jan 24, 2025
Closed
FarazGIS
FarazGIS reviewed Jan 24, 2025
View reviewed changes
Comment thread specification/maps/data-plane/Route/stable/2025-01-01/route.json
FarazGIS
FarazGIS approved these changes Jan 24, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@FarazGIS FarazGIS left a 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.

stevemunk
stevemunk reviewed Feb 19, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@stevemunk stevemunk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the docs and examples for version 2025-01-01 still be referencing version 2024-07-01-preview? If so, what is different between versions 2025-01-01 and 2024-07-01-preview in these specific cases? What is supported in 2024-07-01-preview that is not supported in 2025-01-01?

For example, support for high-definition polygons started in 2024-07-01-preview but referencing that version in the 2025-01-01 docs/examples will be confusing to some users.

Comment thread specification/maps/data-plane/Route/stable/2025-01-01/route.json
Comment thread ...ation/maps/data-plane/Route/stable/2025-01-01/examples/GetRouteOperationStatusCompleted.json Outdated
Comment thread specification/maps/data-plane/Route/stable/2025-01-01/examples/PostRouteMatrixAsync.json Outdated
@koyasu221b
Copy link
Copy Markdown
Member Author

koyasu221b commented Mar 3, 2025

Should the docs and examples for version 2025-01-01 still be referencing version 2024-07-01-preview? If so, what is different between versions 2025-01-01 and 2024-07-01-preview in these specific cases? What is supported in 2024-07-01-preview that is not supported in 2025-01-01?

For example, support for high-definition polygons started in 2024-07-01-preview but referencing that version in the 2025-01-01 docs/examples will be confusing to some users.

@koyasu221b koyasu221b closed this Mar 3, 2025
@koyasu221b koyasu221b reopened this Mar 3, 2025
@koyasu221b
Copy link
Copy Markdown
Member Author

koyasu221b commented Mar 3, 2025

Should the docs and examples for version 2025-01-01 still be referencing version 2024-07-01-preview? If so, what is different between versions 2025-01-01 and 2024-07-01-preview in these specific cases? What is supported in 2024-07-01-preview that is not supported in 2025-01-01?
For example, support for high-definition polygons started in 2024-07-01-preview but referencing that version in the 2025-01-01 docs/examples will be confusing to some users.

Good point. Fixed

@koyasu221b koyasu221b closed this Mar 3, 2025
@koyasu221b koyasu221b reopened this Mar 3, 2025
@koyasu221b koyasu221b added APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. and removed DoNotMerge <valid label in PR review process> use to hold merge after approval labels Mar 4, 2025
@koyasu221b koyasu221b merged commit 478602d into main Mar 4, 2025
@koyasu221b koyasu221b deleted the users/huangwill/koyasu221b-maps-Route-2025-01-01 branch March 4, 2025 06:58
pjpatel12 pushed a commit to pjpatel12/azure-rest-api-specs that referenced this pull request Apr 29, 2025
@koyasu221b @pjpatel12
Route 2025-01-01 (Azure#31929)
786f4b6 
* first commit

* update RouteRange

* Add tollDistanceInMeters

* Update distanceBudgetInMeters and timeBudgetInSec

* Add OptimizedWaypoint

* fix cspell

* Add drivingSide and address

* move drivingSide to instruction

* Update countryRegion to be consistent with geocoding.

* Update from feedbacks

* Add description for countryRegion

* Update description for manuever

* departureAt, arrivalAt, createdAt and lastActionAt

* Remove readonly

* update description for RouteOperationResponse

* remove AzureMapsPricingTier

* update Preview Supplemental Terms

* remove x-ms-client-flatten

* remove en-us

* update operationId

* updaet route description

* fix api-version

---------

Co-authored-by: Will Huang <huangwill@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stevemunk stevemunk stevemunk left review comments

@weidongxu-microsoft weidongxu-microsoft weidongxu-microsoft approved these changes

@mikekistler mikekistler mikekistler approved these changes

@FarazGIS FarazGIS FarazGIS approved these changes

@JeffreyRichter JeffreyRichter Awaiting requested review from JeffreyRichter JeffreyRichter was automatically assigned from Azure/api-stewardship-board

@johanste johanste Awaiting requested review from johanste johanste was automatically assigned from Azure/api-stewardship-board

Assignees

No one assigned

Labels

APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. data-plane Maps new-api-version PipelineBotTrigger PublishToCustomers Acknowledgement the changes will be published to Azure customers.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Azure Maps - Azure Maps] Route API 2025-01-01 Offline Review

7 participants

@koyasu221b @azure-sdk @FarazGIS @stevemunk @weidongxu-microsoft @mikekistler @AzureRestAPISpecReview
⚡