Adding changes for Distributed Node info list along with new API version 2023 04 01 for RecoveryServicesBackup #24210
Conversation
This file contains hidden or 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
…/2023-02-01 to version 2023-04-01
|
Hi, @chandrikagonuguntla 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] |
ghost
added
the
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| bms.json | 2023-04-01(35fde2b) | 2023-02-01(main) |
| bms.json | 2023-04-01(35fde2b) | 2022-09-30-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version is missing a definition that was found in the old version. Was 'AzureVmWorkloadSAPHanaHSR' removed or renamed? New: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L4587:3 Old: Microsoft.RecoveryServices/preview/2022-09-30-preview/bms.json#L4587:3 |
|
| The new version is missing a property found in the old version. Was 'actionRequired' renamed or removed? New: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L4760:7 Old: Microsoft.RecoveryServices/preview/2022-09-30-preview/bms.json#L4743:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| package-2023-04 | package-2023-04(35fde2b) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L10121 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources is missing. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L20 |
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections is missing. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L20 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L21 |
|
The parameters:vaultName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L22 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L48 |
|
The parameters:vaultName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L65 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L97 |
|
The parameters:vaultName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L117 |
|
Synchronous PATCH must have 200 return code. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L117 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L136 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L136 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L136 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L164 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L164 |
|
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L194 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L194 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L209 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L209 |
|
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L239 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L239 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L254 |
|
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L254 |
|
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L284 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L284 |
|
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}' Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L299 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/bms.json#L299 |
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The readme file has more than one default tag. readme: specification/recoveryservicesbackup/resource-manager/readme.md |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi, @chandrikagonuguntla, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
|
The automation detected this Pull Request introduces breaking changes to an existing API version and hence it added the |
This was referenced May 29, 2023
openapi-workflow-bot
bot
added
FixS360
ARMReview
WaitForARMFeedback
|
Hi, @chandrikagonuguntla your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
11 tasks
@mentat9 could you please review this |
Please follow the instructions in this comment to hand your PR back to ARM review: #24210 (comment). Current ARM review on-call will revisit. |
chandrikagonuguntla
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
ms-zhenhua
added
ARMSignedOff
|
@JackTn I need 1 approving review, could you please review the PR |
|
@chandrikagonuguntla check the avocado validation error |
|
Go breaking changes are introduced in: #23600, not related with this PR. |
tadelesh
added
the
Approved-SdkBreakingChange-Go
@JackTn Avocado is expected to fail for recoveryservicesbackup because we have swagger for both passive and active stamps hence 2 defaults. |
|
@JackTn Could you please check comment #24210 (comment) and sign off on the PR |
approve avocado |
@msyyc take a look on this pr and help merge it, Thanks |
JackTn
added
the
Approved-OkToMerge
|
@msyyc please check comment #24210 (comment) and help with the merge |
msyyc
approved these changes
Jun 15, 2023
msyyc
deleted the
chandrikagonuguntla-recoveryservicesbackup-Microsoft.RecoveryServices-2023-04-01
branch
This was referenced Jun 15, 2023
Closed
harryli0108
pushed a commit
to harryli0108/azure-rest-api-specs
that referenced
this pull request
Jul 28, 2023
…ion 2023 04 01 for RecoveryServicesBackup (Azure#24210) * Adds base for updating Microsoft.RecoveryServices from version stable/2023-02-01 to version 2023-04-01 * Updates readme * Updates API version in new specs and examples * Adding nodeslist to Azure Workload Protectable Item response * Updating global settings * Updating VMWorkloadProtectableItem response to be compliant * Update readme.md * removing breaking change * Update ListOperations.json for prettier check * prettier fix
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.
ARM API Information (Control Plane)
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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.