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.DataProtection to add version preview/2022-09-01-preview #20823

Merged
merged 16 commits into from
Sep 29, 2022
Merged

[Hub Generated] Review request for Microsoft.DataProtection to add version preview/2022-09-01-preview #20823

merged 16 commits into from
Sep 29, 2022

Conversation

amchandn
Copy link
Contributor

@amchandn amchandn commented Sep 22, 2022

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

ARM API Information (Control Plane)

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, @amchandn 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 Sep 22, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 8 Warnings warning [Detail]
    compared swaggers (via Oad v0.9.7)] new version base version
    dataprotection.json 2022-09-01-preview(b503351) 2022-05-01(main)
    dataprotection.json 2022-09-01-preview(b503351) 2022-03-31-preview(main)

    The following breaking changes are detected by comparison with the latest preview version:

    Rule Message
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
    New: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7027:9
    Old: Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json#L6438:9
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4652:11
    Old: Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json#L4255:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L1092:13
    Old: Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json#L1092:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L1143:13
    Old: Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json#L1143:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L1151:13
    Old: Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json#L1151:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L1157:13
    Old: Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json#L1157:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L1450:13
    Old: Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json#L1450:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4627:5
    Old: Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json#L4230:5
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 30 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-preview-2022-09 package-preview-2022-09(b503351) default(main)

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ R1003 - ListInOperationName Since operation 'DppResourceGuardProxy-List' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3557
    ⚠️ R1005 - GetInOperationName 'GET' operation 'DppResourceGuardProxy-List' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3557
    ⚠️ R1005 - GetInOperationName 'GET' operation 'DppResourceGuardProxy-Get' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3604
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'DppResourceGuardProxy-Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3652
    ⚠️ R1009 - DeleteInOperationName 'DELETE' operation 'DppResourceGuardProxy-Delete' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3709
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L5292
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7129
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'deletedBackupInstances' with immediate parent 'BackupVaultResource', must have a list by immediate parent operation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L5283
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'backupResourceGuardProxies' with immediate parent 'BackupVaultResource', must have a list by immediate parent operation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7121
    ⚠️ R4000 - ParameterDescriptionRequired 'resourceGuardProxyName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3618
    ⚠️ R4000 - ParameterDescriptionRequired 'resourceGuardProxyName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3666
    ⚠️ R4000 - ParameterDescriptionRequired 'resourceGuardProxyName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3723
    ⚠️ R4000 - ParameterDescriptionRequired 'resourceGuardProxyName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3773
    ⚠️ R4021 - DescriptionAndTitleMissing 'ResourceGuardOperationDetail' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7089
    ⚠️ R4021 - DescriptionAndTitleMissing 'vaultCriticalOperation' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7092
    ⚠️ R4021 - DescriptionAndTitleMissing 'defaultResourceRequest' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7095
    ⚠️ R4021 - DescriptionAndTitleMissing 'ResourceGuardProxyBase' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7100
    ⚠️ R4021 - DescriptionAndTitleMissing 'resourceGuardResourceId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7103
    ⚠️ R4021 - DescriptionAndTitleMissing 'resourceGuardOperationDetails' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7106
    ⚠️ R4021 - DescriptionAndTitleMissing 'lastUpdatedTime' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7113
    ⚠️ R4021 - DescriptionAndTitleMissing 'description' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7116
    ⚠️ R4021 - DescriptionAndTitleMissing 'ResourceGuardProxyBaseResource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7121
    ⚠️ R4021 - DescriptionAndTitleMissing 'resourceGuardOperationRequests' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7157
    ⚠️ R4021 - DescriptionAndTitleMissing 'resourceToBeDeleted' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7163
    ⚠️ R4022 - OperationDescriptionOrSummaryRequired DeletedBackupInstances_Undelete lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L2561
    ⚠️ R4022 - OperationDescriptionOrSummaryRequired DppResourceGuardProxy-List lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3553
    ⚠️ R4022 - OperationDescriptionOrSummaryRequired DppResourceGuardProxy-Get lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3600
    ⚠️ R4022 - OperationDescriptionOrSummaryRequired DppResourceGuardProxy-Put lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3648
    ⚠️ R4022 - OperationDescriptionOrSummaryRequired DppResourceGuardProxy-Delete lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3705
    ⚠️ R4022 - OperationDescriptionOrSummaryRequired DppResourceGuardProxy-UnlockDelete lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3755


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R4037 - MissingTypeObject The schema 'AzureBackupFindRestorableTimeRangesRequestResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4004
    R4037 - MissingTypeObject The schema 'AzureBackupFindRestorableTimeRangesResponseResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4035
    R4037 - MissingTypeObject The schema 'AzureBackupRecoveryPointResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4296
    R4037 - MissingTypeObject The schema 'BackupInstanceResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4627
    R4037 - MissingTypeObject The schema 'BackupVaultResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4794
    R4037 - MissingTypeObject The schema 'BaseBackupPolicyResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4854
    R4037 - MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L5054
    R4037 - MissingTypeObject The schema 'Error' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L5651
    R4037 - MissingTypeObject The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L5689
    R4037 - MissingTypeObject The schema 'additionalDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L5911
    R4037 - MissingTypeObject The schema 'additionalDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L5959
    R4039 - ParametersOrder The parameters:operationId,location should be kept in the same order as they present in the path.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L64
    ⚠️ R1001 - OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'BackupInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L1417
    ⚠️ R1001 - OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'BackupInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L2035
    ⚠️ R1001 - OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'ResourceGuards' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L2968
    ⚠️ R1001 - OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'ResourceGuards' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3283
    ⚠️ R1003 - ListInOperationName Since operation 'BackupVaultsGetInSubscription' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L27
    ⚠️ R1003 - ListInOperationName Since operation 'BackupVaultsGetInResourceGroup' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L289
    ⚠️ R1003 - ListInOperationName Since operation 'ResourceGuardsGetResourcesInSubscription' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L2618
    ⚠️ R1003 - ListInOperationName Since operation 'ResourceGuardsGetResourcesInResourceGroup' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L2660
    ⚠️ R1003 - ListInOperationName Since operation 'ResourceGuardsGetDisableSoftDeleteRequestsObjects' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L2916
    ⚠️ R1003 - ListInOperationName Since operation 'ResourceGuardsGetDeleteResourceGuardProxyRequestsObjects' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L2968
    ⚠️ R1003 - ListInOperationName Since operation 'ResourceGuardsGetBackupSecurityPINRequestsObjects' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3020
    ⚠️ R1003 - ListInOperationName Since operation 'ResourceGuardsGetDeleteProtectedItemRequestsObjects' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3072
    ⚠️ R1003 - ListInOperationName Since operation 'ResourceGuardsGetUpdateProtectionPolicyRequestsObjects' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3124
    ⚠️ R1003 - ListInOperationName Since operation 'ResourceGuardsGetUpdateProtectedItemRequestsObjects' response has model definition 'x-ms-pageable', 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.DataProtection/preview/2022-09-01-preview/dataprotection.json#L3176
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'ResourceGuards_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L2705
    ⚠️ R1007 - PatchInOperationName 'PATCH' operation 'ResourceGuards_Patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L2858
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4043
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4216
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️⚠️~[Staging] TrafficValidation: 1 Warnings warning [Detail]

    restlerResult: Request coverage (successful / total): 31 / 67 Attempted requests: 46 / 67
    Traffic validation failed. Check pipeline artifact for restler output and detail report.

    Rule Message
    ⚠️ Traffic validation result. "Starting task Test...\nUsing python: 'python3' (Python 3.10.5)\nRequest coverage (successful / total): 31 / 67\nAttempted requests: 46 / 67\nBugs were found!\nBug buckets:
    main_driver_500: 1\nTask Test succeeded.\nCollecting logs...\n"
    ️️✔️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: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/b503351dcd921a9006e589736180b86a71603623/specification/dataprotection/resource-manager/readme.md#tag-package-preview-2022-09">dataprotection/resource-manager/readme.md#package-preview-2022-09
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"dataprotection/resource-manager/readme.md",
    "tag":"package-preview-2022-09",
    "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.
    ️️✔️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 Sep 22, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/dataprotection/armdataprotection - 2.0.0-beta.1
    +	Function `*Client.CheckFeatureSupport` has been removed
    +	Struct `CloudError` has been removed
    +	Type of `ResourceGuard.ProvisioningState` has been changed from `*ProvisioningState` to `*ResourceGuardProvisioningState`

    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from f556f64. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/dataprotection/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] No usable version of the libssl was found
      cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
      cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f556f64. 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
    • ️✔️track2_azure-mgmt-dataprotection [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation BackupInstancesOperations.begin_resume_backups
      info	[Changelog]   - Added operation BackupInstancesOperations.begin_resume_protection
      info	[Changelog]   - Added operation BackupInstancesOperations.begin_stop_protection
      info	[Changelog]   - Added operation BackupInstancesOperations.begin_suspend_backups
      info	[Changelog]   - Added operation BackupInstancesOperations.begin_sync_backup_instance
      info	[Changelog]   - Added operation BackupInstancesOperations.get_backup_instance_operation_result
      info	[Changelog]   - Added operation group BackupInstancesExtensionRoutingOperations
      info	[Changelog]   - Added operation group DataProtectionClientOperationsMixin
      info	[Changelog]   - Added operation group DeletedBackupInstancesOperations
      info	[Changelog]   - Added operation group OperationStatusBackupVaultContextOperations
      info	[Changelog]   - Added operation group OperationStatusResourceGroupContextOperations
      info	[Changelog]   - Model AzureBackupRecoveryPointBasedRestoreRequest has a new parameter source_resource_id
      info	[Changelog]   - Model AzureBackupRecoveryTimeBasedRestoreRequest has a new parameter source_resource_id
      info	[Changelog]   - Model AzureBackupRestoreRequest has a new parameter source_resource_id
      info	[Changelog]   - Model AzureBackupRestoreWithRehydrationRequest has a new parameter source_resource_id
      info	[Changelog]   - Model BackupInstance has a new parameter validation_type
      info	[Changelog]   - Model BackupInstanceResource has a new parameter tags
      info	[Changelog]   - Model BackupVault has a new parameter is_vault_protected_by_resource_guard
      info	[Changelog]   - Model BackupVault has a new parameter monitoring_settings
      info	[Changelog]   - Model BackupVault has a new parameter security_settings
      info	[Changelog]   - Model PatchResourceRequestInput has a new parameter properties
      info	[Changelog]   - Model SecretStoreResource has a new parameter value
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f556f64. 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/dataprotection/armdataprotection [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `ResourceGuard.ProvisioningState` has been changed from `*ProvisioningState` to `*ResourceGuardProvisioningState`
      info	[Changelog] - Function `*Client.CheckFeatureSupport` has been removed
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `SoftDeleteStateOff`
      info	[Changelog] - New const `ImmutabilityStateDisabled`
      info	[Changelog] - New const `SoftDeleteStateOn`
      info	[Changelog] - New const `ResourceGuardProvisioningStateUnknown`
      info	[Changelog] - New const `ImmutabilityStateUnlocked`
      info	[Changelog] - New const `ResourceGuardProvisioningStateProvisioning`
      info	[Changelog] - New const `SoftDeleteStateAlwaysOn`
      info	[Changelog] - New const `ResourceGuardProvisioningStateFailed`
      info	[Changelog] - New const `ResourceGuardProvisioningStateSucceeded`
      info	[Changelog] - New const `ResourceGuardProvisioningStateUpdating`
      info	[Changelog] - New const `StorageSettingTypesZoneRedundant`
      info	[Changelog] - New const `ImmutabilityStateLocked`
      info	[Changelog] - New type alias `ResourceGuardProvisioningState`
      info	[Changelog] - New type alias `SoftDeleteState`
      info	[Changelog] - New type alias `ImmutabilityState`
      info	[Changelog] - New function `PossibleSoftDeleteStateValues() []SoftDeleteState`
      info	[Changelog] - New function `*Client.DppResourceGuardProxyGet(context.Context, string, string, string, *ClientDppResourceGuardProxyGetOptions) (ClientDppResourceGuardProxyGetResponse, error)`
      info	[Changelog] - New function `PossibleImmutabilityStateValues() []ImmutabilityState`
      info	[Changelog] - New function `NewDeletedBackupInstancesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*DeletedBackupInstancesClient, error)`
      info	[Changelog] - New function `*BackupInstancesExtensionRoutingClient.NewListPager(string, *BackupInstancesExtensionRoutingClientListOptions) *runtime.Pager[BackupInstancesExtensionRoutingClientListResponse]`
      info	[Changelog] - New function `*DeletedBackupInstancesClient.Get(context.Context, string, string, string, *DeletedBackupInstancesClientGetOptions) (DeletedBackupInstancesClientGetResponse, error)`
      info	[Changelog] - New function `*Client.DppResourceGuardProxyDelete(context.Context, string, string, string, *ClientDppResourceGuardProxyDeleteOptions) (ClientDppResourceGuardProxyDeleteResponse, error)`
      info	[Changelog] - New function `*Client.DppResourceGuardProxyUnlockDelete(context.Context, string, string, string, UnlockDeleteRequest, *ClientDppResourceGuardProxyUnlockDeleteOptions) (ClientDppResourceGuardProxyUnlockDeleteResponse, error)`
      info	[Changelog] - New function `*Client.DppResourceGuardProxyPut(context.Context, string, string, string, ResourceGuardProxyBaseResource, *ClientDppResourceGuardProxyPutOptions) (ClientDppResourceGuardProxyPutResponse, error)`
      info	[Changelog] - New function `*DeletedBackupInstancesClient.BeginUndelete(context.Context, string, string, string, *DeletedBackupInstancesClientBeginUndeleteOptions) (*runtime.Poller[DeletedBackupInstancesClientUndeleteResponse], error)`
      info	[Changelog] - New function `PossibleResourceGuardProvisioningStateValues() []ResourceGuardProvisioningState`
      info	[Changelog] - New function `*DeletedBackupInstancesClient.NewListPager(string, string, *DeletedBackupInstancesClientListOptions) *runtime.Pager[DeletedBackupInstancesClientListResponse]`
      info	[Changelog] - New function `*Client.NewDppResourceGuardProxyListPager(string, string, *ClientDppResourceGuardProxyListOptions) *runtime.Pager[ClientDppResourceGuardProxyListResponse]`
      info	[Changelog] - New function `NewBackupInstancesExtensionRoutingClient(azcore.TokenCredential, *arm.ClientOptions) (*BackupInstancesExtensionRoutingClient, error)`
      info	[Changelog] - New struct `BackupInstancesExtensionRoutingClient`
      info	[Changelog] - New struct `BackupInstancesExtensionRoutingClientListOptions`
      info	[Changelog] - New struct `BackupInstancesExtensionRoutingClientListResponse`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyDeleteOptions`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyDeleteResponse`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyGetOptions`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyGetResponse`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyListOptions`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyListResponse`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyPutOptions`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyPutResponse`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyUnlockDeleteOptions`
      info	[Changelog] - New struct `ClientDppResourceGuardProxyUnlockDeleteResponse`
      info	[Changelog] - New struct `DeletedBackupInstance`
      info	[Changelog] - New struct `DeletedBackupInstanceResource`
      info	[Changelog] - New struct `DeletedBackupInstanceResourceList`
      info	[Changelog] - New struct `DeletedBackupInstancesClient`
      info	[Changelog] - New struct `DeletedBackupInstancesClientBeginUndeleteOptions`
      info	[Changelog] - New struct `DeletedBackupInstancesClientGetOptions`
      info	[Changelog] - New struct `DeletedBackupInstancesClientGetResponse`
      info	[Changelog] - New struct `DeletedBackupInstancesClientListOptions`
      info	[Changelog] - New struct `DeletedBackupInstancesClientListResponse`
      info	[Changelog] - New struct `DeletedBackupInstancesClientUndeleteResponse`
      info	[Changelog] - New struct `DeletionInfo`
      info	[Changelog] - New struct `DppProxyResource`
      info	[Changelog] - New struct `ImmutabilitySettings`
      info	[Changelog] - New struct `ResourceGuardOperationDetail`
      info	[Changelog] - New struct `ResourceGuardProxyBase`
      info	[Changelog] - New struct `ResourceGuardProxyBaseResource`
      info	[Changelog] - New struct `ResourceGuardProxyBaseResourceList`
      info	[Changelog] - New struct `SecuritySettings`
      info	[Changelog] - New struct `SoftDeleteSettings`
      info	[Changelog] - New struct `UnlockDeleteRequest`
      info	[Changelog] - New struct `UnlockDeleteResponse`
      info	[Changelog] - New field `SecuritySettings` in struct `PatchBackupVaultInput`
      info	[Changelog] - New field `Tags` in struct `BackupInstanceResource`
      info	[Changelog] - New field `IsVaultProtectedByResourceGuard` in struct `BackupVault`
      info	[Changelog] - New field `SecuritySettings` in struct `BackupVault`
      info	[Changelog]
      info	[Changelog] Total 4 breaking change(s), 100 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f556f64. 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-dataprotectionplatform [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from f556f64. 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.dataprotection [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 Sep 22, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/dataprotection/armdataprotection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Python track2_azure-mgmt-dataprotection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-dataprotection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-dataprotectionplatform Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @openapi-workflow-bot
    Copy link

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

    @amchandn amchandn marked this pull request as ready for review September 23, 2022 05:46
    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 23, 2022
    @openapi-workflow-bot
    Copy link

    Hi, @amchandn your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @amchandn
    Copy link
    Contributor Author

    Most of the changes in this API have already been reviewed and approved by ARM team in a PR raised in swagger's private repo -
    https://github.com/Azure/azure-rest-api-specs-pr/pull/7480

    @amchandn
    Copy link
    Contributor Author

    /azp run unifiedPipeline

    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

    @amchandn
    Copy link
    Contributor Author

    /azp run unifiedPipeline

    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

    @mentat9
    Copy link
    Member

    mentat9 commented Sep 28, 2022

        "state": {
    

    Nicely done.


    In reply to: 1260293048


    Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json:6661 in 3d96f0c. [](commit_id = 3d96f0c, deletion_comment = False)

    @mentat9
    Copy link
    Member

    mentat9 commented Sep 28, 2022

    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}/undelete": {
    

    Makes sense.


    In reply to: 1260293405


    Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json:2560 in 3d96f0c. [](commit_id = 3d96f0c, deletion_comment = False)

    @mentat9
    Copy link
    Member

    mentat9 commented Sep 28, 2022

        "state": {
    

    Recommend adding per-value descriptions for this property as well (not blocking ARM signoff).


    Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json:5505 in b503351. [](commit_id = b503351, deletion_comment = False)

    @mentat9
    Copy link
    Member

    mentat9 commented Sep 28, 2022

        "resourceGuardOperationRequests": {
    

    Description would be helpful.


    Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json:7157 in b503351. [](commit_id = b503351, deletion_comment = False)

    @mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 28, 2022
    @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 28, 2022
    @mentat9
    Copy link
    Member

    mentat9 commented Sep 28, 2022

    @amchandn - Signed off for ARM with comments.

    @amchandn
    Copy link
    Contributor Author

        "state": {
    

    Recommend adding per-value descriptions for this property as well (not blocking ARM signoff).

    Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json:5505 in b503351. [](commit_id = b503351, deletion_comment = False)

    thanks for the suggestion. We'll plan and take up this exercise to add enum descriptions for all enum values in our swagger in upcoming versions.

    @amchandn
    Copy link
    Contributor Author

        "resourceGuardOperationRequests": {
    

    Description would be helpful.

    Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json:7157 in b503351. [](commit_id = b503351, deletion_comment = False)

    thanks for the suggestion. We'll plan and take up this exercise to add all missing descriptions in our swagger in upcoming versions.

    @jianyexi
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    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-BreakingChange-Go CI-FixRequiredOnFailure 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.

    6 participants