-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
[Hub Generated] Review request for Microsoft.DataProtection to add version preview/2022-09-01-preview #20823
Conversation
…022-05-01 to version 2022-09-01-preview
Hi, @amchandn Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
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:
️️✔️
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] |
---|---|---|
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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L5292 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L7129 |
||
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 |
||
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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
'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 |
||
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 |
||
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 |
||
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 |
||
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 |
||
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 |
||
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 |
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
'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 |
|
'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 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json#L4043 |
|
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 |
---|---|
"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
Rule | Message |
---|---|
"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.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @amchandn, Your PR has some issues. Please fix the CI sequentially by following the order of
|
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). |
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 - |
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
…rotection-2022-09-01-preview
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) |
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) |
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) |
@amchandn - Signed off for ARM with comments. |
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. |
thanks for the suggestion. We'll plan and take up this exercise to add all missing descriptions in our swagger in upcoming versions. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
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:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.