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

Clean up for Cross Version BreakingChange PR check #14194

Closed
wants to merge 1 commit into from

Conversation

Sandido
Copy link
Member

@Sandido Sandido commented Apr 29, 2021

Almost all Compute Swagger PRs have the Cross Version BreakingChange PR check failing due to a comparison to the 2016-04-30 preview API version.

This cleanup work is to edit the 2016 preview version to avoid this breaking change error.

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @Sandido Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @ghost ghost added the Compute label Apr 29, 2021
    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 29, 2021

    Swagger Validation Report

    ️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]
    Rule Message
    1008 - ModifiedOperationId The operation id has been changed from 'VirtualMachines_GetExtensions' to 'VirtualMachineExtensions_List'. This will impact generated code.
    New: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L646:7
    Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L646:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'managed' renamed or removed?
    New: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3160:7
    Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3160:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'properties' renamed or removed?
    New: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3683:7
    Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3687:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'overProvision' renamed or removed?
    New: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L5272:7
    Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L5144:7
    1045 - AddedOptionalProperty The new version has a new optional property 'overprovision' that was not found in the old version.
    New: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L5272:7
    Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L5144:7
    ️⚠️LintDiff: 2 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'VirtualMachineExtensions_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L646
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: overprovision
    Location: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L5286


    The following errors/warnings exist before current PR submission:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L36
    D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_Update'
    Location: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L85
    D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_Delete'
    Location: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L164
    D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_GrantAccess'
    Location: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L279
    D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_RevokeAccess'
    Location: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L327
    D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Update'
    Location: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L425
    D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Delete'
    Location: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L504
    D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_GrantAccess'
    Location: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L611
    D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_RevokeAccess'
    Location: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L655
    R2054 - SecurityDefinitionsStructure Every swagger/configuration must have a security definitions section and it must adhere to the structure described in: https://github.com/Azure/azure-openapi-validator/blob/master/docs/security-definitions-structure-validation.md
    Location: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L1
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/compute/resource-manager/readme.md
    tag: specification/compute/resource-manager/readme.md#tag-package-2021-03-01
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"compute/resource-manager/readme.md",
    "tag":"package-2016-04-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"compute/resource-manager/readme.md",
    "tag":"package-2016-04-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"compute/resource-manager/readme.md",
    "tag":"package-2016-04-preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"compute/resource-manager/readme.md",
    "tag":"package-compute-2016-04-preview",
    "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"compute/resource-manager/readme.md",
    "tag":"package-compute-2016-04-preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 29, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌ azure-sdk-for-go failed [Detail]
    • Failed [Logs] Generate from 01b37182eebb2806707ab0e2b6a1a246257b9e54. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
      cmderr	[main.go] [AUTOREST] FATAL: System.InvalidOperationException: Swagger document contains two or more x-ms-enum extensions with the same name 'StorageAccountTypes' and different values: Standard_LRS,Premium_LRS,StandardSSD_LRS,UltraSSD_LRS vs. Standard_LRS,Premium_LRS
      cmderr	[main.go] [AUTOREST]    at AutoRest.Modeler.ObjectBuilder.BuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISH8kiit\38_20171116T010915\autorest.modeler\src\ObjectBuilder.cs:line 147
      cmderr	[main.go] [AUTOREST]    at AutoRest.Modeler.SchemaBuilder.ParentBuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISH8kiit\38_20171116T010915\autorest.modeler\src\SchemaBuilder.cs:line 204
      cmderr	[main.go] [AUTOREST]    at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISH8kiit\38_20171116T010915\autorest.modeler\src\SchemaBuilder.cs:line 46
      cmderr	[main.go] [AUTOREST]    at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISH8kiit\38_20171116T010915\autorest.modeler\src\SchemaBuilder.cs:line 131
      cmderr	[main.go] [AUTOREST]    at AutoRest.Modeler.SchemaBuilder.BuildServiceType(String serviceTypeName, Boolean required) in C:\Users\ci\AppData\Local\Temp\PUBLISH8kiit\38_20171116T010915\autorest.modeler\src\SchemaBuilder.cs:line 131
      cmderr	[main.go] [AUTOREST]    at AutoRest.Modeler.SwaggerModeler.BuildCompositeTypes() in C:\Users\ci\AppData\Local\Temp\PUBLISH8kiit\38_20171116T010915\autorest.modeler\src\SwaggerModeler.cs:line 271
      cmderr	[main.go] [AUTOREST]    at AutoRest.Modeler.SwaggerModeler.Build(ServiceDefinition serviceDefinition) in C:\Users\ci\AppData\Local\Temp\PUBLISH8kiit\38_20171116T010915\autorest.modeler\src\SwaggerModeler.cs:line 66
      cmderr	[main.go] [AUTOREST]    at AutoRest.Modeler.Program.<ProcessInternal>d__2.MoveNext() in C:\Users\ci\AppData\Local\Temp\PUBLISH8kiit\38_20171116T010915\autorest.modeler\src\Program.cs:line 60
      cmderr	[main.go] [AUTOREST] --- End of stack trace from previous location where exception was thrown ---
      cmderr	[main.go] [AUTOREST]    at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
      cmderr	[main.go] [AUTOREST]    at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
      cmderr	[main.go] [AUTOREST]    at NewPlugin.<Process>d__15.MoveNext()
      cmderr	[main.go] [AUTOREST] FATAL: go/imodeler1 - FAILED
      cmderr	[main.go] [AUTOREST] FATAL: Error: Plugin imodeler1 reported failure.
      cmderr	[main.go] [AUTOREST] Failure during batch task - {"tag":"package-compute-2016-04-preview"} -- Error: Plugin imodeler1 reported failure..
      cmderr	[main.go] [AUTOREST]   Error: Plugin imodeler1 reported failure.
      cmderr	[main.go] [ERROR] total 1 error(s):
      cmderr	[main.go] [ERROR] cannot generate readme 'specification/compute/resource-manager/readme.md': autorest error with arguments '--use=@microsoft.azure/autorest.go@2.1.180, --go, --verbose, --go-sdk-folder=., --multiapi, --use-onever, --version=V2, --go.license-header=MICROSOFT_MIT_NO_VERSION, ../../../../../azure-rest-api-specs/specification/compute/resource-manager/readme.md, --metadata-output-folder=../../../../../azure-rest-api-specs/specification/compute/resource-manager':
      cmderr	[main.go] [ERROR] exit status 1
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: go run ./tools/generator/main.go
      warn	Skip package processing as generation is failed
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 01b37182eebb2806707ab0e2b6a1a246257b9e54. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/compute/resource-manager/readme.md
    • ️✔️@azure/arm-compute [View full logs]  [Preview SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/computeManagementClient.js → ./dist/arm-compute.js...
      cmderr	[npmPack] created ./dist/arm-compute.js in 1.4s
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 01b37182eebb2806707ab0e2b6a1a246257b9e54. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	Skip detect changed packages
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 01b37182eebb2806707ab0e2b6a1a246257b9e54. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-compute [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 01b37182eebb2806707ab0e2b6a1a246257b9e54. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-04-29 16:56:31 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-compute-generated"
      cmderr	[generate.py] 2021-04-29 16:56:31 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-04-29 16:56:31 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.25 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/compute/azure-resourcemanager-compute-generated --java.namespace=com.azure.resourcemanager.compute.generated   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/compute/resource-manager/readme.md
      cmderr	[generate.py] 2021-04-29 16:58:15 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-04-29 16:58:15 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-04-29 16:58:15 INFO [POM][Skip] pom already has module azure-resourcemanager-compute-generated
      cmderr	[generate.py] 2021-04-29 16:58:15 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-04-29 16:58:15 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-04-29 16:58:15 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-compute-generated [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-04-29 17:03:35 DEBUG Got artifact_id: azure-resourcemanager-compute-generated
      cmderr	[Inst] 2021-04-29 17:03:35 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-04-29 17:03:35 DEBUG Got artifact: azure-resourcemanager-compute-generated-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-04-29 17:03:35 DEBUG Got artifact: azure-resourcemanager-compute-generated-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-04-29 17:03:35 DEBUG Got artifact: azure-resourcemanager-compute-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-04-29 17:03:35 DEBUG Match jar package: azure-resourcemanager-compute-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-04-29 17:03:35 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14194/azure-sdk-for-java/azure-resourcemanager-compute-generated/azure-resourcemanager-compute-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-compute-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-compute-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-compute-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️⚠️ azure-sdk-for-net warning [Detail]
    • ⚠️Warning [Logs] Generate from 01b37182eebb2806707ab0e2b6a1a246257b9e54. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/compute/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      warn	No file changes detected after generation
      warn	No package detected after generation
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @Sandido, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @JackTn
    Copy link
    Member

    JackTn commented Jun 16, 2022

    Hi, @Sandido. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days.

    2 similar comments
    @JackTn
    Copy link
    Member

    JackTn commented Jun 16, 2022

    Hi, @Sandido. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days.

    @JackTn
    Copy link
    Member

    JackTn commented Jun 16, 2022

    Hi, @Sandido. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days.

    @JackTn JackTn deleted the adsandor/2016BreakingChangeRemoval branch July 5, 2022 01:19
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants