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

Azure Notification Hubs Revert Namespace List Keys Change #16221

Merged
merged 3 commits into from
Dec 15, 2021

Conversation

mpodwysocki
Copy link
Member

@mpodwysocki mpodwysocki commented Sep 29, 2021

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

Changelog

Add a changelog entry for 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 - regression in namespace list keys operations
  2. When are you targeting to deploy the new service/feature to public regions? Not a new feature, just a bug fix
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required 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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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, @mpodwysocki 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. [email protected]

    @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 Sep 29, 2021

    Swagger Validation Report

    ️❌BreakingChange: 27 Errors, 0 Warnings failed [Detail]
    Rule Message
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.OperationalInsights/operations' removed or restructured?
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables' removed or restructured?
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Tables.json#L37:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}' removed or restructured?
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Tables.json#L82:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces' removed or restructured?
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L37:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces' removed or restructured?
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L76:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}' removed or restructured?
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L118:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/deletedWorkspaces' removed or restructured?
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L319:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/deletedWorkspaces' removed or restructured?
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L358:5
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'Schema' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SearchResults' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'RestoredLogs' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ResultStatistics' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'TableProperties' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'Table' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'systemData' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'WorkspaceSku' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'WorkspaceCapping' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'WorkspaceProperties' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'WorkspaceFeatures' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'Workspace' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'WorkspacePatch' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'PublicNetworkAccessType' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L37:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L74:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ApiVersionParameter' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L38:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L123:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'TableNameParameter' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L38:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L123:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'WorkspaceNameParameter' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L38:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L123:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceGroupNameParameter' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L38:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L123:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'SubscriptionIdParameter' removed or renamed?
    New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L38:3
    Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json#L123:3
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/operationalinsights/resource-manager/readme.md
    tag: specification/operationalinsights/resource-manager/readme.md#tag-package-2021-06
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 29, 2021

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️⌛SDK Breaking Change Tracking pending [Detail]
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from d92d7a9. 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
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.3.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.3.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-notificationhubs [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from d92d7a9. 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] 2022-01-05 11:41:43 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-notificationhubs;1.0.0-beta.3;1.0.0-beta.4"
      cmderr	[generate.py] 2022-01-05 11:41:43 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.4"
      cmderr	[generate.py] 2022-01-05 11:41:43 INFO autorest --version=3.6.6 --use=@autorest/[email protected] --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/notificationhubs/azure-resourcemanager-notificationhubs --java.namespace=com.azure.resourcemanager.notificationhubs   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/notificationhubs/resource-manager/readme.md
      cmderr	[generate.py] 2022-01-05 11:42:08 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-notificationhubs
      cmderr	[generate.py] 2022-01-05 11:42:08 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2022-01-05 11:42:08 INFO [POM][Skip] pom already has module azure-resourcemanager-notificationhubs
      cmderr	[generate.py] 2022-01-05 11:42:08 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2022-01-05 11:42:08 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2022-01-05 11:42:08 INFO [POM][Skip] pom already has module sdk/notificationhubs
      cmderr	[generate.py] 2022-01-05 11:42:08 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-notificationhubs [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2022-01-05 11:43:17 DEBUG Got artifact_id: azure-resourcemanager-notificationhubs
      cmderr	[Inst] 2022-01-05 11:43:17 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2022-01-05 11:43:17 DEBUG Got artifact: azure-resourcemanager-notificationhubs-1.0.0-beta.4.jar
      cmderr	[Inst] 2022-01-05 11:43:17 DEBUG Match jar package: azure-resourcemanager-notificationhubs-1.0.0-beta.4.jar
      cmderr	[Inst] 2022-01-05 11:43:17 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/16221/azure-sdk-for-java/azure-resourcemanager-notificationhubs/azure-resourcemanager-notificationhubs-1.0.0-beta.4.jar\" -o azure-resourcemanager-notificationhubs-1.0.0-beta.4.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-notificationhubs -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-notificationhubs-1.0.0-beta.4.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d92d7a9. SDK Automation 14.0.0
      command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️notificationhubs/mgmt/2017-04-01/notificationhubs [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️notificationhubs/mgmt/2016-03-01/notificationhubs [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️notificationhubs/mgmt/2014-09-01/notificationhubs [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d92d7a9. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armnotificationhubs [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Field `SharedAccessAuthorizationRuleListResult` of struct `NamespacesListKeysResult` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New anonymous field `ResourceListKeys` in struct `NamespacesListKeysResult`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 1 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from d92d7a9. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      cmderr	[automation_init.sh] WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] npm notice created a lockfile as package-lock.json. You should commit this file.
      cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️track2_@azure/arm-notificationhubs [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from d92d7a9. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
    • ️✔️notificationhubs [View full logs
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @mpodwysocki, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @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.

    @openapi-workflow-bot
    Copy link

    Hi @mpodwysocki, 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.

    @raych1
    Copy link
    Member

    raych1 commented Sep 30, 2021

    @mpodwysocki , can you paste the previous PR which you revert?

    @mpodwysocki
    Copy link
    Member Author

    @raych1 The commit that contained the changes is here Updating swagger for Notification Hubs to add examples which added the regression for the list keys which has been fixed in this PR

    @raych1
    Copy link
    Member

    raych1 commented Oct 1, 2021

    @raych1 The commit that contained the changes is here Updating swagger for Notification Hubs to add examples which added the regression for the list keys which has been fixed in this PR

    The previous PR is merged in 2018. If that is the change you want to revert, then this PR needs to go through breaking change review. Please follow the action in above comment.

    @ghost
    Copy link

    ghost commented Nov 7, 2021

    Hi, @mpodwysocki. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Nov 7, 2021
    @ghost ghost closed this Nov 22, 2021
    @ghost
    Copy link

    ghost commented Nov 22, 2021

    Hi, @mpodwysocki. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    @msyyc
    Copy link
    Member

    msyyc commented Jan 5, 2022

    /azp run

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-Go-V2 CI-BreakingChange-Go-V2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants