Skip to content

Updated the LocalizedMapView enum to reflect the addition of the US view #34561

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

stevemunk
Copy link
Contributor

Data Plane API Specification Update Pull Request

🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
Updated the LocalizedMapView enum to reflect the addition of the US view, as per @faterceros

Updated in specification/maps/data-plane/Common/preview/1.0/common.json

This enum is referenced by the following Azure Maps Services/versions:

Render: v1.0, v2022-08-01, v2024-04-01
Search: v1.0

🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨

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:
  • Previous API Spec Doc:
  • Updated paths:

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.

Release planner

A release plan should have been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Getting help

  • First, please carefully read through this PR description, from top to bottom.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@stevemunk stevemunk requested a review from a team as a code owner May 9, 2025 16:26
Copy link

openapi-pipeline-app bot commented May 9, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR has at least one change violating Azure versioning policy (label: VersioningReviewRequired).
    To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) follow the process at aka.ms/brch.
  • ❌ The required check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.

Copy link

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

@microsoft-github-policy-service microsoft-github-policy-service bot added customer-reported Issues that are reported by GitHub users external to the Azure organization. Maps labels May 9, 2025
Copy link

github-actions bot commented May 9, 2025

API Change Check

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

Language API Review for Package
Swagger AsyncBatchManagement

@AzureRestAPISpecReview AzureRestAPISpecReview added data-plane VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required labels May 9, 2025
Copy link

@faterceros faterceros left a comment

Choose a reason for hiding this comment

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

Changes requested to accommodate for US View - Label changes to "Gulf of Ameria" for US View Only._

@FarazGIS FarazGIS added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label May 9, 2025
@FarazGIS
Copy link
Contributor

@Azure/api-stewardship-board @allenjzhang @mario-guerra Could you please review the PR? Thanks!

@mikekistler
Copy link
Member

This PR requires review/approval of the deviation from Azure Versioning Policy. Pls come to the next Breaking Changes Office hours to discuss. Normally these are Mondays at 10-11 AM, but are cancelled next week due to the US holiday, so the next office hours will be Monday 6/2. You can also email the Azure Breaking Change reviewers to explain why the Versioning policy is not being followed, or if you need an explanation for why the PR was flagged as non-compliant.

@faterceros
Copy link

@Azure/api-stewardship-board @mikekistler
The Version policy is not being followed because the "[Global [Readiness]

https://msit.powerbi.com/groups/me/apps/3abfab4e-307a-4ebf-afaa-6b867bca2d70/reports/5180ca13-1780-438f-990e-5dacfe092767/ReportSection?ctid=72f988bf-86f1-41af-91ab-2d7cd011db47&experience=power-bi&filter=new_geographicissues%2FIntegerID%20eq%2069

The executive order " requirement to add a new Geopol view across all productscame in from GlobalReadiness (CELA) in response to political events in the United States immediately. This includes 'Auto' detection in old versions of the API and making it available across the full product as fast as possible. The US-View fall under these CELA guidelines. Additionally, this does not change the type/fields returned in the response only specific values. It will not break old clients. @FarazGIS

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. data-plane Maps PublishToCustomers Acknowledgement the changes will be published to Azure customers. VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants