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

Revert "[Service Bus] - Adding status code 202 to Private endpoints PUT" #19755

Merged
merged 1 commit into from
Jul 13, 2022

Conversation

ruowan
Copy link
Member

@ruowan ruowan commented Jul 13, 2022

Reverts #19125

@openapi-workflow-bot
Copy link

Hi, @ruowan 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 13, 2022

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.6)] new version base version
    namespace-preview.json 2022-01-01(0600d27) 2022-01-01(main)
    Rule Message
    1012 - RemovedResponseCode The new version removes the response code '202'
    Old: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L442:11
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-01-preview package-2022-01-preview(0600d27) package-2022-01-preview(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L935
    ⚠️ R1003 - ListInOperationName Since operation 'PrivateLinkResourcesGet' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L552
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Namespaces_Update' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L281
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateLinkResources_Get' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L548
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'SBNamespace', must have a list by immediate parent operation.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L983
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneRedundant
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L734
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L753
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L824
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: requireInfrastructureEncryption
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L955
    ⚠️ R4021 - DescriptionAndTitleMissing 'groupId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L1112
    ⚠️ R4021 - DescriptionAndTitleMissing 'userAssignedIdentityProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L1148
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: NameSpaceCreate
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L346
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/0600d276d626cb9a46a9da663b28d4aafd9b77cb/specification/servicebus/resource-manager/readme.md#tag-package-2022-01-preview">servicebus/resource-manager/readme.md#package-2022-01-preview
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"servicebus/resource-manager/readme.md",
    "tag":"package-2022-01-preview",
    "details":"Schema 'SqlRuleAction' has a property 'sqlExpression' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"servicebus/resource-manager/readme.md",
    "tag":"package-2022-01-preview",
    "details":"Schema 'SqlRuleAction' has a property 'compatibilityLevel' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"servicebus/resource-manager/readme.md",
    "tag":"package-2022-01-preview",
    "details":"Schema 'SqlRuleAction' has a property 'requiresPreprocessing' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction"
    ⚠️ UnkownSecurityScheme "readme":"servicebus/resource-manager/readme.md",
    "tag":"package-2022-01-preview",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 13, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - armservicebus - 2.0.0-beta.2
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-servicebus - 7.1.0
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a960d5b. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-servicebus [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a960d5b. 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
    • ️✔️armservicebus [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a960d5b. 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]  deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  deprecated uuid@3.4.0: 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]  deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 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
    • ️✔️@azure/arm-servicebus [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Type Alias KeySource
      info	[Changelog]   - Added Type Alias PublicNetworkAccess
      info	[Changelog]   - Added Type Alias TlsVersion
      info	[Changelog]   - Type Alias SBNamespace has a new parameter minimumTlsVersion
      info	[Changelog]   - Type Alias SBNamespace has a new parameter publicNetworkAccess
      info	[Changelog]   - Added Enum KnownAccessRights
      info	[Changelog]   - Added Enum KnownFilterType
      info	[Changelog]   - Added Enum KnownKeySource
      info	[Changelog]   - Added Enum KnownKeyType
      info	[Changelog]   - Added Enum KnownManagedServiceIdentityType
      info	[Changelog]   - Added Enum KnownProvisioningStateDR
      info	[Changelog]   - Added Enum KnownPublicNetworkAccess
      info	[Changelog]   - Added Enum KnownRoleDisasterRecovery
      info	[Changelog]   - Added Enum KnownSkuName
      info	[Changelog]   - Added Enum KnownSkuTier
      info	[Changelog]   - Added Enum KnownTlsVersion
      info	[Changelog]   - Added Enum KnownUnavailableReason
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a960d5b. 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]  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
    • ️✔️servicebus [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a960d5b. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.ServiceBus [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @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 @ruowan, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    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 CI-FixRequiredOnFailure
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants