Skip to content
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

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

koyasu221b
Copy link
Member

@koyasu221b koyasu221b commented Dec 19, 2024

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.

Copy link

openapi-pipeline-app bot commented Dec 19, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR requires an API stewardship board review as it introduces a new API version (label: new-api-version). Schedule the review by following aka.ms/azsdk/onboarding/restapischedule.
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 4 in the PR workflow diagram

Copy link

openapi-pipeline-app bot commented Dec 19, 2024

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
Collaborator

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 JeffreyRichter, johanste, mikekistler and FarazGIS 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
Copy link
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.

Copy link
Member

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

"trafficCongestion": {
"$ref": "#/definitions/TrafficCongestionEnum"
},
"departureTime": {
Copy link
Member

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 and arriveAt
  • InputRouteRangeProperties has departAt
  • RoutePathProperties, Leg, and RouteMatrixItemResult have date-time properties departureTime and arrivalTime
  • RouteOperation has createdDateTime and lastActionDateTime

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.

@FarazGIS
Copy link
Contributor

@stevemunk @pbrasil Sharing the Route PR as we will publishing the swagger docs in the next few weeks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data-plane DoNotMerge <valid label in PR review process> use to hold merge after approval Maps new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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