Skip to content

[Hub Generated] Review request for Microsoft.DataReplication to add version preview/2021-02-16-preview#24903

Closed
minhsuanlee wants to merge 2 commits into
mainfrom
minhsuanlee-azuresiterecovery-Microsoft.DataReplication-2021-02-16-preview
Closed

[Hub Generated] Review request for Microsoft.DataReplication to add version preview/2021-02-16-preview#24903
minhsuanlee wants to merge 2 commits into
mainfrom
minhsuanlee-azuresiterecovery-Microsoft.DataReplication-2021-02-16-preview

Conversation

@minhsuanlee

@minhsuanlee minhsuanlee commented Jul 19, 2023

Copy link
Copy Markdown
Contributor

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

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

ARM API changes review

  • If you want for the ARM team to review this PR, you must add the ARMReview label.
  • The automation may automatically add the ARMReview label, if appropriate.
    If this happens, proceed according to guidance given in GitHub comments also added by the automation.

Breaking change review

If you have any breaking changes as defined in the Breaking Change Policy,
follow the process outlined in the High-level Breaking Change Process doc.

Getting help

@openapi-workflow-bot

Copy link
Copy Markdown

Hi, @minhsuanlee! Thank you for your pull request. To help get your PR merged:

  • Ensure you reviewed the checklists in the PR description.
  • Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.
  • For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
  • @openapi-pipeline-app

    openapi-pipeline-app Bot commented Jul 19, 2023

    Copy link
    Copy Markdown

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️❌LintDiff: 16 Errors, 177 Warnings failed [Detail]
    compared tags (via openapi-validator v2.1.3) new version base version
    package-2021-02-16-preview package-2021-02-16-preview(5ef4eea) default(main)

    [must fix]The following errors/warnings are introduced by current PR:

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

    Rule Message Related RPC [For API reviewers]
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L135
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L205
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L758
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L834
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L896
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L1192
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L1262
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L1519
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L1595
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L1735
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L2067
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L2137
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.DataReplication/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L2349
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L2536
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L2612
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L2674
    ⚠️ PreviewVersionOverOneYear The API version:2021-02-16-preview having been in a preview state over one year , please move it to GA or retire.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L6
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L24
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L24
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L24
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L84
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L84
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L84
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L159
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L159
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L159
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L231
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L231
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L231
    ⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'operationId'.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json#L285
    ️️✔️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: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️All merging requirements met succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app

    openapi-pipeline-app Bot commented Jul 19, 2023

    Copy link
    Copy Markdown

    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-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 281e0091410ced102f2890f3b34ef57276749390. 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! 9.5.1 -> 9.8.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.8.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-azuresiterecovery [View full logs]  [Preview SDK Changes]
      info	[Changelog]   - Initial Release
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 281e0091410ced102f2890f3b34ef57276749390. 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
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-azuresiterecovery [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 281e0091410ced102f2890f3b34ef57276749390. 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/azuresiterecovery/armazuresiterecovery [View full logs]  [Preview SDK Changes]
      info	[Changelog] This is a new package
      info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 281e0091410ced102f2890f3b34ef57276749390. 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-azuresiterecovery [View full logs]  [Preview 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] Generate from 281e0091410ced102f2890f3b34ef57276749390. 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
    • ️✔️azuresiterecovery [View full logs]  [Preview Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs] Generate from 281e0091410ced102f2890f3b34ef57276749390. 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
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ️✔️Az.azuresiterecovery.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.azuresiterecovery.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app

    openapi-pipeline-app Bot commented Jul 19, 2023

    Copy link
    Copy Markdown

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.DataReplication https://apiview.dev/Assemblies/Review/324db1b792424a81bb84208b54e03626
    Go sdk/resourcemanager/azuresiterecovery/armazuresiterecovery https://apiview.dev/Assemblies/Review/2e02777bde754ab1ac32a3d1cc10c9ca
    Java azure-resourcemanager-azuresiterecovery https://apiview.dev/Assemblies/Review/055dc55650a14e2eb90e0f1437c7993a
    JavaScript @azure/arm-azuresiterecovery Create ApiView failed. Please ask PR assignee for help

    @openapi-workflow-bot

    Copy link
    Copy Markdown

    Hi @minhsuanlee This PR was flagged for introducing a new RP namespace that is not being onboarded with RPaaS. Merging this PR to the main branch will be blocked as RPaaS is required for new RPs. To resolve this and allow the PR to be merged into the main branch, please use RPaaS to onboard the new RP.

    @openapi-workflow-bot

    Copy link
    Copy Markdown

    Hi, @minhsuanlee, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved.
    Action Required:

  • Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.
  • Paste the issue link that you created in step 1 in this PR

  • Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

    @minhsuanlee

    Copy link
    Copy Markdown
    Contributor Author
    • he issue link that you created in step 1 in this PR

    Link to New RP Namespace Issue: https://github.com/Azure/azure-sdk-pr/issues/1220

    @konrad-jamrozik

    konrad-jamrozik commented Jul 20, 2023

    Copy link
    Copy Markdown

    @rkmanda I assigned you as @minhsuanlee was asking me for help with LintDiff failures. I also added WaitForARMFeedback to put this PR on your review queue.

    @konrad-jamrozik konrad-jamrozik added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 20, 2023
    @minhsuanlee minhsuanlee marked this pull request as ready for review July 21, 2023 20:33
    @openapi-workflow-bot

    Copy link
    Copy Markdown

    Hi @minhsuanlee! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic ValidationFix-SemanticValidation-ErrorHigh
    Model ValidationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffHigh

    If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.

    @minhsuanlee

    Copy link
    Copy Markdown
    Contributor Author

    For LintDiff errors LroErrorContent and OperationsApiResponseSchema, I have taken necessary steps to locally reproduce the errors but from what I can tell, the cause of the error does not seem to be valid as our schema is already following the guidelines. I even tried copy-paste the schema from types.json to our swagger directly and re-run Lint validation, it still failed.

    @mayada83 mayada83 left a comment

    Copy link
    Copy Markdown

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Looks good.

    @konrad-jamrozik

    konrad-jamrozik commented Jul 24, 2023

    Copy link
    Copy Markdown

    @mayada83 if you confirm the Swagger LintDiff check failure is incorrect, please add the Approved-LintDiff label. If you approve this PR on behalf of the ARM team, please add the ARMSignedOff label. Thank you!

    @minhsuanlee

    Copy link
    Copy Markdown
    Contributor Author

    Moving to a new PR [Hub Generated] Review request for Microsoft.DataReplication to add version preview/2021-02-16-preview #24974 as Service Name has been updated from 'azuresiterecovery' to 'recoveryservicesdatareplication'

    @visingla-ms

    Copy link
    Copy Markdown
    Contributor

    {

    Observed that your new RP is not RPaaS based RP. Non-RPaaS RPs are not allowed, unless you have got an exception. If that's the case, please forward me the RPaaS exception email/communication for your RP.


    Refers to: specification/azuresiterecovery/resource-manager/Microsoft.DataReplication/preview/2021-02-16-preview/azuresiterecovery.json:1 in 5ef4eea. [](commit_id = 5ef4eea, deletion_comment = False)

    @openapi-workflow-bot

    Copy link
    Copy Markdown

    Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    This will notify the reviewer to have another look.
    If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
    Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

    @openapi-workflow-bot openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 26, 2023
    @microsoft-github-policy-service

    Copy link
    Copy Markdown
    Contributor

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

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

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    6 participants