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

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

Conversation

minhsuanlee
Copy link
Contributor

@minhsuanlee minhsuanlee commented Jul 25, 2023

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

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
    Copy link

    openapi-pipeline-app bot commented Jul 25, 2023

    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: 2 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.4) new version base version
    package-2021-02-16-preview package-2021-02-16-preview(c654865) default(main)

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ 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/recoveryservicesdatareplication.json#L6
    ⚠️ AllProxyResourcesShouldHaveDelete The resource EmailConfigurationModel does not have a corresponding delete operation.
    Location: Microsoft.DataReplication/preview/2021-02-16-preview/recoveryservicesdatareplication.json#L2988
    RPC-Delete-V1-05
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView 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).
    ️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️Automated merging requirements met succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 25, 2023

    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 d7faf1258ee642619aa30531061367b8ba45ddff. 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 major version of npm available! 9.6.7 -> 10.0.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.0.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-recoveryservicesdatareplication [View full logs]  [Preview SDK Changes]
      info	[Changelog]   - Initial Release
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d7faf1258ee642619aa30531061367b8ba45ddff. 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/recoveryservicesdatareplication/armrecoveryservicesdatareplication [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 d7faf1258ee642619aa30531061367b8ba45ddff. 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-recoveryservicesdatareplication [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 failed [Detail]
    • Code Generator Failed [Logs] Generate from d7faf1258ee642619aa30531061367b8ba45ddff. 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]  ERR! code EBADENGINE
      cmderr	[initScript.sh]  Unsupported engine
      cmderr	[initScript.sh] npm ERR! engine Not compatible with your version of node/npm: [email protected]
      cmderr	[initScript.sh] npm ERR! notsup Not compatible with your version of node/npm: [email protected]
      cmderr	[initScript.sh] npm ERR! notsup Required: {"node":"^18.17.0 || >=20.5.0"}
      cmderr	[initScript.sh] npm ERR! notsup Actual:   {"npm":"8.19.4","node":"v16.20.2"}
      cmderr	[initScript.sh]  A complete log of this run can be found in:
      cmderr	[initScript.sh] npm ERR!     /home/cloudtest/.npm/_logs/2023-09-05T21_14_04_656Z-debug-0.log
      error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
      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
      cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500
      cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
      cmderr	[generateScript.sh]            ^
      cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
      cmderr	[generateScript.sh] cmd/generateall.ts(7,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(11,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(12,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(14,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(15,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
      cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(64,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(81,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
      cmderr	[generateScript.sh] cmd/generateall.ts(82,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
      cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(117,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(118,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.
      cmderr	[generateScript.sh] cmd/generateall.ts(169,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i @types/node` and then add `node` to the types field in your tsconfig.
      cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12)
      cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19)
      cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36)
      cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32)
      cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43)
      cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1252:10)
      cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12)
      cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1076:32)
      cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:911:12)
      cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
      cmderr	[generateScript.sh]  notice
      cmderr	[generateScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.0.0
      cmderr	[generateScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.0.0>
      cmderr	[generateScript.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[generateScript.sh] npm notice
      error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
      warn	Skip package processing as generation is failed
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 25, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/recoveryservicesdatareplication/armrecoveryservicesdatareplication https://apiview.dev/Assemblies/Review/e6192a4515a748dea2fa337a7f3c01f4
    Java azure-resourcemanager-recoveryservicesdatareplication https://apiview.dev/Assemblies/Review/1228bf1ce46141cfab701866f85f9d2c
    JavaScript @azure/arm-recoveryservicesdatareplication https://apiview.dev/Assemblies/Review/bf852e9a7884479cbdb543aec8f56650
    .Net Azure.ResourceManager.Recoveryservicesdatareplication https://apiview.dev/Assemblies/Review/f20b81ffabe54cfe8b09811179370ea7
    Swagger Microsoft.DataReplication https://apiview.dev/Assemblies/Review/356f6604fec94748bf4d0ae80b3bb489

    @openapi-workflow-bot
    Copy link

    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

    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.

    @openapi-workflow-bot
    Copy link

    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
    Contributor Author

    minhsuanlee commented Jul 25, 2023

    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.


    In reply to: 1650585436

    @minhsuanlee minhsuanlee requested a review from mayada83 July 25, 2023 22:28
    @minhsuanlee minhsuanlee removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 1, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 1, 2023
    @sjanamma sjanamma added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 1, 2023
    @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 Sep 1, 2023
    @minhsuanlee
    Copy link
    Contributor Author

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @minhsuanlee
    Copy link
    Contributor Author

    /pr RequestMerge

    @minhsuanlee minhsuanlee changed the title [Hub Generated] Review request for Microsoft.DataReplication to add version preview/2021-02-16-preview [Hub Generated] Review request for Microsoft.RecoveryServicesDataReplication to add version preview/2021-02-16-preview Sep 5, 2023
    @mentat9
    Copy link
    Member

    mentat9 commented Sep 5, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @mentat9
    Copy link
    Member

    mentat9 commented Sep 5, 2023

    @minhsuanlee - Your PR needs to pass required checks before merge. Add the MergeRequested label back after addressing those items. If you get stuck, you can ask for help in the API Spec Review Teams channel: https://teams.microsoft.com/l/channel/19%3a0351f5f9404446e4b4fd4eaf2c27448d%40thread.skype/API%2520Spec%2520Review?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47. Pinned comments on that channel identify help contacts for SDK breaking change reviewers.

    1 similar comment
    @mentat9
    Copy link
    Member

    mentat9 commented Sep 5, 2023

    @minhsuanlee - Your PR needs to pass required checks before merge. Add the MergeRequested label back after addressing those items. If you get stuck, you can ask for help in the API Spec Review Teams channel: https://teams.microsoft.com/l/channel/19%3a0351f5f9404446e4b4fd4eaf2c27448d%40thread.skype/API%2520Spec%2520Review?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47. Pinned comments on that channel identify help contacts for SDK breaking change reviewers.

    @minhsuanlee minhsuanlee force-pushed the minhsuanlee-recoveryservicesdatareplication-Microsoft.DataReplication-2021-02-16-preview branch from f8d2dca to c654865 Compare September 5, 2023 21:02
    @minhsuanlee minhsuanlee changed the title [Hub Generated] Review request for Microsoft.RecoveryServicesDataReplication to add version preview/2021-02-16-preview [Hub Generated] Review request for Microsoft.DataReplication to add version preview/2021-02-16-preview Sep 5, 2023
    @minhsuanlee
    Copy link
    Contributor Author

    /pr RequestMerge

    @mentat9 mentat9 added Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates MergeRequested and removed MergeRequested Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates labels Sep 6, 2023
    @mentat9 mentat9 self-requested a review September 6, 2023 17:08
    @mentat9 mentat9 merged commit ebb636f into main Sep 6, 2023
    @mentat9 mentat9 deleted the minhsuanlee-recoveryservicesdatareplication-Microsoft.DataReplication-2021-02-16-preview branch September 6, 2023 17:09
    jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
    …ersion preview/2021-02-16-preview (#24974)
    
    * Generate new Service for recoveryservicesdatareplication
    
    * Initial commit
    
    * New version
    
    * Fixed LintDiff with common types
    
    * Included auto gen net sdk
    
    * Addressed some ARM feedback
    
    * Updated swagger
    
    * Updated and corrected swagger
    
    * Addressed PR comments about tags
    
    ---------
    
    Co-authored-by: Sam Lee <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-NewRPNamespaceWithoutRPaaS new-api-version new-rp-namespace ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    9 participants