Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.
MIT License
2.69k stars 5.11k forks source link

Update deployment version APIs definitions #31605

Open ZianWang02 opened 2 days ago

ZianWang02 commented 2 days ago

ARM (Control Plane) API Specification Update Pull Request

[!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

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:

Additional information

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 [suppressions guide](https://aka.ms/azsdk/pr-suppressions) to get approval.

Getting help

openapi-pipeline-app[bot] commented 2 days ago

Next Steps to Merge

Next steps that must be taken to merge this PR:
openapi-pipeline-app[bot] commented 2 days ago

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/cdn/armcdn https://apiview.dev/Assemblies/Review/5e345519a8864b018f9aae9fb7ba934c?revisionId=b8e431e885344e38942b56bfd697d052
JavaScript @azure/arm-cdn https://apiview.dev/Assemblies/Review/d03c7f4c0d164abd85030a921f78f9ad?revisionId=25ab748721de46b7ad8a7f656a053020
Java azure-resourcemanager-cdn-generated https://apiview.dev/Assemblies/Review/a857fa609d3c43b09808544a49c0693b?revisionId=eb5354d7244144ff9931807d5bb83d87
Python azure-mgmt-cdn https://apiview.dev/Assemblies/Review/554f619b5bce4305ab34ed93bfc66da9?revisionId=70101e12d5ce4592a014d888090f74d4
azure-sdk commented 2 days ago

API change check

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

Microsoft.Cdn

ZianWang02 commented 2 days ago

/azp run

azure-pipelines[bot] commented 2 days ago
Azure Pipelines successfully started running 3 pipeline(s).
ZianWang02 commented 2 days ago

Hi ARM DRI, our deployment version feature is controlled by the feature flag and not used by any customer yet. We would like to update the swagger for the 2024-06-01-preview version to update the definition. Can we add the tag "Versioning-Approved-BugFix" to bypass the breaking change check? Here is the changes for this PR:

  1. Update the property of the deploymentVersion.properties.stages.production to an enum value.
  2. Update the property of the deploymentVersion.properties.stages.preview to an enum value.
  3. Remove the Microsoft.Cdn/profiles/securitypolicies from the enum DeploymentVersionChange because it is not supported.
ms-bogdan-rotaru commented 1 day ago

@ZianWang02 The breaking change label has to be added by the Breaking Change Review board - aka.ms/brch Please get this approval first and get put the PR back in the queue for API review.

ZianWang02 commented 1 day ago

Hi @ms-bogdan-rotaru, is it possible for us to bypass the Breaking Change review because the API related to the Microsoft.Cdn/profiles/deploymentversions is controlled by the feature flag and not opened to any customer yet?

ms-bogdan-rotaru commented 21 hours ago

Please follow the instructions and details provided at https://aka.ms/brch. Only the members of Breaking Change approval board can take these decisions.