[Hub Generated] Review request for Microsoft.RecoveryServices to add version preview/2022-09-01-preview #20578
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…/2022-04-01 to version 2022-09-01-preview
|
Hi, @pratimaupadhyay02 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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| registeredidentities.json | 2022-09-01-preview(c77c3c7) | 2022-08-01(main) |
| registeredidentities.json | 2022-09-01-preview(c77c3c7) | 2022-01-31-preview(main) |
| replicationusages.json | 2022-09-01-preview(c77c3c7) | 2022-08-01(main) |
| replicationusages.json | 2022-09-01-preview(c77c3c7) | 2022-01-31-preview(main) |
| vaults.json | 2022-09-01-preview(c77c3c7) | 2022-08-01(main) |
| vaults.json | 2022-09-01-preview(c77c3c7) | 2022-01-31-preview(main) |
| vaultusages.json | 2022-09-01-preview(c77c3c7) | 2022-08-01(main) |
| vaultusages.json | 2022-09-01-preview(c77c3c7) | 2022-01-31-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 17 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 17 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 17 Errors, 8 Warnings failed [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-09 | package-preview-2022-09(c77c3c7) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 17 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Tracked resource 'RecoveryServicesTrackedResource' must have a get operation. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L1252 |
|
|
Tracked resource 'RecoveryServicesTrackedResource' must have patch operation that at least supports the update of tags. It's strongly recommended that the PATCH operation supports update of all mutable properties as well. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L1252 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L31 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L81 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L136 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L200 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L255 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L340 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L387 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L434 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L503 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L547 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L621 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L668 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L724 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L779 |
|
|
Do not have duplicate name of client parameter name, make sure every client parameter name unique. Client parameter #/parameters/SubscriptionIdParameter conflicted with #/parameters/SubscriptionId. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L830 |
The following errors/warnings exist before current PR submission:
Only 17 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/registeredidentities.json#L21 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/registeredidentities.json#L80 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/replicationusages.json#L21 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaultusages.json#L21 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/registeredidentities.json#L64 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/registeredidentities.json#L108 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/replicationusages.json#L45 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaultusages.json#L45 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/registeredidentities.json#L108 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json#L517 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/replicationusages.json#L70 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/replicationusages.json#L74 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/replicationusages.json#L78 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/replicationusages.json#L88 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/replicationusages.json#L92 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/replicationusages.json#L96 |
|
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/preview/2022-09-01-preview/replicationusages.json#L100 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 39 Errors, 0 Warnings failed [Detail]
Tag package-preview-2022-09; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 20, untested: 0, failed: 17, passed: 3
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 17 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
"statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'locations/checkNameAvailability' could not be found in the namespace 'Microsoft.RecoveryServices' for api version '2022-09-01-preview'. The supported api-versions are '2018-01-10'." |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 400, errorCode: InvalidRestApiParameter, errorMessage: publicNetworkAccess parameter is invalid. Please provide a valid publicNetworkAccess" |
|
"expected response code to be 2XX but found 400" |
|
"Additional properties not allowed: innerError" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RecoveryServices/vaults/vaultnamea4ndf2' under resource group 'apiTest-kYOIwa-20578' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RecoveryServices/vaults/vaultnamea4ndf2' under resource group 'apiTest-kYOIwa-20578' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RecoveryServices/vaults/vaultnamea4ndf2' under resource group 'apiTest-kYOIwa-20578' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RecoveryServices/vaults/vaultnamea4ndf2' under resource group 'apiTest-kYOIwa-20578' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RecoveryServices/vaults/vaultnamea4ndf2' under resource group 'apiTest-kYOIwa-20578' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"expected response code to be 2XX but found 404" |
|
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RecoveryServices/vaults/vaultnamea4ndf2' under resource group 'apiTest-kYOIwa-20578' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
|
"expected response code to be 2XX but found 404" |
️⚠️~[Staging] TrafficValidation: 1 Warnings warning [Detail]
restlerResult: Request coverage (successful / total): 4 / 20 Attempted requests: 6 / 20
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): 4 / 20\nAttempted requests: 6 / 20\nNo bugs were found.\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/c77c3c7aec14c20ea960379dbf1863283f23be29/specification/recoveryservices/resource-manager/readme.md#tag-package-preview-2022-09">recoveryservices/resource-manager/readme.md#package-preview-2022-09
| Rule | Message |
|---|---|
| "readme":"recoveryservices/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
|
ghost
added
the
|
Hi @pratimaupadhyay02, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Sep 4, 2022
This was referenced Sep 4, 2022
This reverts commit 07d89d4.
xiaoxuqi-ms
approved these changes
Sep 6, 2022
xiaoxuqi-ms
requested changes
Sep 6, 2022
|
@jianyexi , could you help to take a look at the breaking change check? |
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
mentat9
reviewed
Sep 27, 2022
...yservices/resource-manager/Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json
Outdated
Show resolved
Hide resolved
mentat9
reviewed
Sep 27, 2022
| "description": "Security Settings of the vault", | ||
| "type": "object", | ||
| "properties": { | ||
| "immutabilitySettings": { |
There was a problem hiding this comment.
This name is similar to what is used by storage (Blob) for the property having same effect
There was a problem hiding this comment.
These are the settings to make resource Immutable. Resource is considered mutable if these settings are not enabled.
There was a problem hiding this comment.
These settings control the mutability of the resource. The general term is mutability which can be set to mutable or immutable. It's cleanest to name the properties and values without unnecessary negation built into the name.
This
{
. . .
securitySettings: {
immutabilitySettings: {
state: { Disabled, Locked, Unlocked }
}
}
}
is wordy and confusing (what's the difference between Disabled and Unlocked?). Something more like this:
{
mutability: { Mutable, Immutable }
}
is simpler and easier to understand.
I won't block ARM approval on this, just want you to reconsider.
There was a problem hiding this comment.
Disable means Immutability is not enabled yet i.e resource is mutable
Unlocked means Immutability is enabled (resource is not mutable) but not yet locked that means it can be reveted from this state.
Locked means Immutability is Locked (resource is not mutable) forever and cannot be reverted at all.
I agree with you we should avoid any negation in Names but all existing resources created till now are mutable by default, now we are exposing feature to make those Immutable. Hence kept name as Immutability Settings and same is used for other resources like RecoveryServiceVaults and Storage resources. As per industry standard also, Immutability is being used in ransomware protection solutions.
mentat9
reviewed
Sep 27, 2022
...yservices/resource-manager/Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json
Show resolved
Hide resolved
mentat9
reviewed
Sep 27, 2022
...yservices/resource-manager/Microsoft.RecoveryServices/preview/2022-09-01-preview/vaults.json
Outdated
Show resolved
Hide resolved
mentat9
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
amchandn
removed
the
ARMChangesRequested
mentat9
added
WaitForARMFeedback
amchandn
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
mentat9
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
…ervices-2022-09-01-preview
|
Reverting publicNetworkAccess property related changes from this version as the feature got delayed from backend. Will add it to later API versions. |
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @pratimaupadhyay02, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This reverts commit 88534a4.
11 tasks
|
Due to timeline changes and feature requirement - we had to change the API version label from 2022-09-01-preview to 2022-10-02-preview. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.