Skip to content

[Servicebus] Adding schema for status code 201 for Disaster-recovery and Migration #23466

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Apr 13, 2023
Merged

[Servicebus] Adding schema for status code 201 for Disaster-recovery and Migration #23466

merged 3 commits into from
Apr 13, 2023

Conversation

@schaudhari6254888
Copy link
Contributor

@schaudhari6254888 schaudhari6254888 commented Apr 6, 2023 •
edited by openapi-workflow-bot bot
Loading

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • 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. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.

  • 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

@openapi-workflow-bot
Copy link

Hi, @schaudhari6254888 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]

    @ghost ghost added the Service Bus label Apr 6, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 6, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    DisasterRecoveryConfig.json 2022-01-01-preview(16f1e6d) 2022-01-01-preview(main)
    migrationconfigs.json 2022-01-01-preview(16f1e6d) 2022-01-01-preview(main)
    DisasterRecoveryConfig.json 2022-10-01-preview(16f1e6d) 2022-10-01-preview(main)
    migrationconfigs.json 2022-10-01-preview(16f1e6d) 2022-10-01-preview(main)
    ️️✔️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 v2.0.0) new version base version
    package-2022-01-preview package-2022-01-preview(16f1e6d) package-2022-01-preview(main)
    package-2022-10-preview package-2022-10-preview(16f1e6d) package-2022-10-preview(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/DisasterRecoveryConfig.json#L37
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/DisasterRecoveryConfig.json#L82
    ❌ TrackedResourcePatchOperation Tracked resource 'ArmDisasterRecovery' must have patch operation that at least supports the update of tags.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/DisasterRecoveryConfig.json#L82
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/DisasterRecoveryConfig.json#L228
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/DisasterRecoveryConfig.json#L270
    ❌ MissingTypeObject The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/DisasterRecoveryConfig.json#L326
    ❌ ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/DisasterRecoveryConfig.json#L329
    ❌ MissingTypeObject The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/DisasterRecoveryConfig.json#L390
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L37
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L82
    ❌ ResourceNameRestriction The resource name parameter 'configName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L82
    ❌ TrackedResourcePatchOperation Tracked resource 'MigrationConfigProperties' must have patch operation that at least supports the update of tags.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L82
    ❌ CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L83
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L229
    ❌ ResourceNameRestriction The resource name parameter 'configName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L229
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L271
    ❌ ResourceNameRestriction The resource name parameter 'configName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L271
    ❌ MissingTypeObject The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/migrationconfigs.json#L318
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/DisasterRecoveryConfig.json#L37
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/DisasterRecoveryConfig.json#L82
    ❌ TrackedResourcePatchOperation Tracked resource 'ArmDisasterRecovery' must have patch operation that at least supports the update of tags.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/DisasterRecoveryConfig.json#L82
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/DisasterRecoveryConfig.json#L228
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/DisasterRecoveryConfig.json#L270
    ❌ MissingTypeObject The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/DisasterRecoveryConfig.json#L326
    ❌ ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/DisasterRecoveryConfig.json#L329
    ❌ MissingTypeObject The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/DisasterRecoveryConfig.json#L390
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/migrationconfigs.json#L37
    ❌ ResourceNameRestriction The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/migrationconfigs.json#L82
    ❌ ResourceNameRestriction The resource name parameter 'configName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/migrationconfigs.json#L82
    ❌ TrackedResourcePatchOperation Tracked resource 'MigrationConfigProperties' must have patch operation that at least supports the update of tags.
    Location: Microsoft.ServiceBus/preview/2022-10-01-preview/migrationconfigs.json#L82
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView 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.
    ️️✔️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.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand] 
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 6, 2023 •
    edited
    Loading

    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-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9bc5a13. 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] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.4
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.4>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️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 9bc5a13. 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
    • ️✔️sdk/resourcemanager/servicebus/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 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9bc5a13. 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
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 PublicNetworkAccess
info	[Changelog]   - Added Type Alias TlsVersion
info	[Changelog]   - Interface SBNamespace has a new optional parameter minimumTlsVersion
info	[Changelog]   - Interface SBNamespace has a new optional parameter premiumMessagingPartitions
info	[Changelog]   - Interface SBNamespace has a new optional parameter publicNetworkAccess
info	[Changelog]   - Added Enum KnownPublicNetworkAccess
info	[Changelog]   - Added Enum KnownTlsVersion
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9bc5a13. 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 9bc5a13. 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.DefaultTag [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 6, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/servicebus/armservicebus https://apiview.dev/Assemblies/Review/e8bc70edfbe846c5a6c7305c7f5fee53
    Java azure-resourcemanager-servicebus-generated https://apiview.dev/Assemblies/Review/b1329c5826be45caafaea7333203adf4
    .Net Azure.ResourceManager.ServiceBus There is no API change compared with the previous version
    JavaScript @azure/arm-servicebus https://apiview.dev/Assemblies/Review/dd5c20d66b6f4baf8a699927f40ddb6f

    @schaudhari6254888 schaudhari6254888 marked this pull request as draft April 6, 2023 21:35
    @azure-sdk azure-sdk mentioned this pull request Apr 6, 2023
    Draft
    This was referenced Apr 6, 2023
    Closed
    Closed
    Closed
    This was referenced Apr 6, 2023
    Closed
    Closed
    Closed
    @schaudhari6254888 schaudhari6254888 marked this pull request as ready for review April 10, 2023 07:25
    @chunyu3 chunyu3 merged commit 9bc5a13 into Azure:main Apr 13, 2023
    This was referenced Apr 13, 2023
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    @azure-sdk azure-sdk mentioned this pull request Apr 13, 2023
    Closed
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    @schaudhari6254888 @JoshLove-msft
    [Servicebus] Adding schema for status code 201 for Disaster-recovery …
    0e9d88e 
    …and Migration (Azure#23466)

* Updates

* UPdates

* Updates
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @chunyu3 chunyu3 chunyu3 approved these changes

    @v-Ajnava v-Ajnava Awaiting requested review from v-Ajnava

    @dsouzaarun dsouzaarun Awaiting requested review from dsouzaarun dsouzaarun is a code owner

    @damodaravadhani damodaravadhani Awaiting requested review from damodaravadhani damodaravadhani is a code owner

    Assignees

    @chunyu3 chunyu3

    Labels

    resource-manager Service Bus

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    3 participants

    @schaudhari6254888 @chunyu3 @AzureRestAPISpecReview