ASR: Adding new Resource replication protection intent and its associated PUT and GET call #10484
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
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version is adding a path that was not found in the old version. New: Microsoft.RecoveryServices/stable/2018-07-10/service.json#L4073:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.RecoveryServices/stable/2018-07-10/service.json#L4116:5 |
️⚠️~[Staging] LintDiff: 4 Warnings warning [Detail] [Expand]
- Linted configuring files (Based on source branch, openapi-validator v1.5.0 , classic-openapi-validator v1.1.4 )
- Linted configuring files (Based on target branch, openapi-validator v1.5.0 , classic-openapi-validator v1.1.4 )
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.RecoveryServices/stable/2018-07-10/service.json#L9710 |
|
| Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.RecoveryServices/stable/2018-07-10/service.json#L18182 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'ReplicationProtectionIntents_Create' Request Model: 'CreateProtectionIntentInput' Response Model: 'ReplicationProtectionIntent' New: Microsoft.RecoveryServices/stable/2018-07-10/service.json#L4162 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isActive New: Microsoft.RecoveryServices/stable/2018-07-10/service.json#L18223 |
️️✔️~[Staging] Avocado succeeded [Detail]
Validation passes for Avocado.
️️✔️~[Staging] ModelValidation succeeded [Detail]
Validation passes for ModelValidation.
️️✔️~[Staging] SemanticValidation succeeded [Detail]
Validation passes for SemanticValidation.
️️✔️~[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail]
There are no breaking changes.
️️✔️~[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail]
There are no breaking changes.
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Can one of the admins verify this patch? |
azure-sdk-for-js - Release
|
Azure CLI Extension Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-go - Release
|
azure-sdk-for-java - Release
|
azure-sdk-for-net - Release
|
Trenton Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-resource-manager-schemas - Release
|
azure-sdk-for-python-track2 - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Aug 17, 2020
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Nov 5, 2020
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Nov 5, 2020
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@qianwens : I have raised swagger exception for the default error response. And as its ARM signed off, can i proceed ahead with adding the suppression code for default error response? |
|
https://github.com/Azure/openapi-diff/blob/master/docs/rules/1038.md |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
I have added suppression for the "default error response" error, as the ARM team has approved it. |
qianwens
added
Approved-BreakingChange
You added new path /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName} to existing path /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}. so that you should add a new API version |
qianwens
added
the
Approved-BreakingChange
|
[3:56 PM] Ayesha Fathima |
qianwens
approved these changes
Nov 6, 2020
giromm2ms
pushed a commit
to giromm2ms/azure-rest-api-specs
that referenced
this pull request
Dec 20, 2020
…ated PUT and GET call (Azure#10484) * protectionIntent * protectionIntent * protectionIntent * pi * protectionIntent * protectionIntent * protectionIntent * pi * pi * model * model * fixing the default response * fixing swagger checks * fixing errors * fixing errors * fixing validations error * fixing prettier checks * fixing * fixing * replication Intent fixing * spelling * fixing camel case * Updating as per latest * fixing syntax issues * fixing few issues * fixing camel case * fixing syntax issues * fixing prettier issues * fixing linter issues * suppressing the default error response message
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.
We are planning to integrate ASR as part of the create VM Blade.
For this, we are introducing a new resource namely “ReplicationProtectionIntent”. And we have added GET, PUT and List API for this resource.
During create vm flow, the replicationProtectionIntent object is created for the VM, the ASR service will take care of enabling replication for the VM internally.
This new PUT API for replicationProtectionIntent is a synchronous API.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Please follow the link to find more details on PR review process.