-
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
Microsoft.Compute: Add new stable API version 2021-03-01 for CloudServices resource #13155
Microsoft.Compute: Add new stable API version 2021-03-01 for CloudServices resource #13155
Conversation
Hi, @stephenhou 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. vsswagger@microsoft.com |
Swagger Validation Report
|
Rule | Message |
---|---|
'PUT' operation 'CloudServicesUpdateDomain_WalkUpdateDomain' 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.Compute/stable/2021-03-01/cloudService.json#L1295 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Compute/stable/2021-03-01/cloudService.json#L1884 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Compute/stable/2021-03-01/cloudService.json#L1963 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2089 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2126 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2221 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2320 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2525 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2621 |
|
Only 'application/json' content-type is supported by ARM. Location: Microsoft.Compute/stable/2021-03-01/cloudService.json#L433 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2021-03-01 |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️
[Staging] Cross Version BreakingChange (Base on preview version): 6 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2020-10-01-preview/cloudService.json <---> new: stable/2021-03-01/cloudService.json
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
[Staging] SDK Track2 Validation: 8 Errors, 9280 Warnings failed [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
- compute/resource-manager/readme.md#package-2020-12-01
- compute/resource-manager/readme.md#package-2020-12-01-only
- compute/resource-manager/readme.md#package-2020-10-01-preview
- compute/resource-manager/readme.md#package-2020-10-01-preview-only
- compute/resource-manager/readme.md#package-2020-09-30
- compute/resource-manager/readme.md#package-2020-09-30-only
- compute/resource-manager/readme.md#package-2020-06-30
- compute/resource-manager/readme.md#package-2020-06-30-only
- compute/resource-manager/readme.md#package-2020-06-01
- compute/resource-manager/readme.md#package-2020-06-01-only
- compute/resource-manager/readme.md#package-2020-05-01
- compute/resource-manager/readme.md#package-2020-05-01-only
- compute/resource-manager/readme.md#package-2019-12-01
- compute/resource-manager/readme.md#package-2019-12-01-only
- compute/resource-manager/readme.md#package-2019-11-01
- compute/resource-manager/readme.md#package-2019-11-01-only
- compute/resource-manager/readme.md#package-2019-07
- compute/resource-manager/readme.md#package-2019-07-01
- compute/resource-manager/readme.md#package-2019-07-01-only
- compute/resource-manager/readme.md#package-2019-03-01
- compute/resource-manager/readme.md#package-2019-04-01-only
- compute/resource-manager/readme.md#package-2019-03-01-only
- compute/resource-manager/readme.md#package-2018-10-01-Disks
- compute/resource-manager/readme.md#package-2018-10-01
- compute/resource-manager/readme.md#package-2018-10-01-only
- compute/resource-manager/readme.md#package-2018-09-30-only
- compute/resource-manager/readme.md#package-2018-06-exclude-gallery
- compute/resource-manager/readme.md#package-2018-06
- compute/resource-manager/readme.md#package-2018-06-01
- compute/resource-manager/readme.md#package-compute-only-2018-06
- compute/resource-manager/readme.md#package-2018-04-01
- compute/resource-manager/readme.md#package-2018-04
- compute/resource-manager/readme.md#package-compute-2018-04
- compute/resource-manager/readme.md#package-disks-2018-04
- compute/resource-manager/readme.md#package-2017-12
- compute/resource-manager/readme.md#package-compute-2017-12
- compute/resource-manager/readme.md#package-compute-only-2017-12
- compute/resource-manager/readme.md#package-skus-2017-09
- compute/resource-manager/readme.md#package-2017-03
- compute/resource-manager/readme.md#package-compute-2017-03
- compute/resource-manager/readme.md#package-container-service-2017-01
- compute/resource-manager/readme.md#package-container-service-2016-09
- compute/resource-manager/readme.md#package-2016-04-preview
- compute/resource-manager/readme.md#package-compute-2016-04-preview
- compute/resource-manager/readme.md#package-2016-03
- compute/resource-manager/readme.md#package-compute-2016-03
- compute/resource-manager/readme.md#package-container-service-2016-03
- compute/resource-manager/readme.md#package-container-service-2015-11-preview
- compute/resource-manager/readme.md#package-compute-2015-06
- compute/resource-manager/readme.md#package-2015-06-preview
- compute/resource-manager/readme.md#profile-hybrid-2020-09-01
- compute/resource-manager/readme.md#package-2021-03-01
- compute/resource-manager/readme.md#package-2021-03-01-only
Rule | Message |
---|---|
PreCheck/DuplicateSchema |
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "description":"The Offer Promotion Code.", "$ref":"#/components/schemas/schemas:1246" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-10-01-preview", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "description":"The Offer Promotion Code.", "$ref":"#/components/schemas/schemas:1168" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-10-01-preview", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-09-30", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "description":"The Offer Promotion Code.", "$ref":"#/components/schemas/schemas:1168" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-09-30", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "description":"The Offer Promotion Code.", "$ref":"#/components/schemas/schemas:1246" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Error: Plugin prechecker reported failure." |
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'ComputeOperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'ComputeOperationValue' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi, @stephenhou your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ArcturusZhang |
Hi @stephenhou, Your PR has some issues. Please fix the CI sequentially by following the order of
|
@@ -61,7 +61,12 @@ | |||
"description": "No Content" | |||
} | |||
}, | |||
"x-ms-long-running-operation": true | |||
"x-ms-long-running-operation": true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please specify x-ms-long-running-operation-options as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this doesn't seem like a strict requirement (should have, not must have). We have been adding several x-ms-long-running-operation in several APIs without options without this being a concern (is this new?). In our case, the default value used (azure-async-operation) is exactly what we want.
If possible, I would strongly prefer to take an item to make this change in the future as it will require some thought in our swagger generation code.
@@ -282,7 +302,12 @@ | |||
"description": "Accepted" | |||
} | |||
}, | |||
"x-ms-long-running-operation": true | |||
"x-ms-long-running-operation": true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add x-ms-long-running-operation-options
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this doesn't seem like a strict requirement (should have, not must have). We have been adding several x-ms-long-running-operation in several APIs without options without this being a concern (is this new?). In our case, the default value used (azure-async-operation) is exactly what we want.
If possible, I would strongly prefer to take an item to make this change in the future as it will require some thought in our swagger generation code.
"type": "string", | ||
"readOnly": true | ||
}, | ||
"location": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to other location resource types in compute, I guess locations/cloudServiceOsFamilies resource also uses ProxyOnly, LocationBased routing. Property 'location' cannot be used as a top level property for proxy resources.
Refer the NOTE section in the RP documentation here: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md#resource-request-properties-envelope
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that the note says that location is not applicable in the request body. However, these ProxyOnly resources are only available through GET. Additionally readonly: true is specified. So location would only be applied for the response body in this situation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As per offline discussion, as cloudServiceOsFamilies can differ based on a location, including location in response sounds reasonable.
"type": "string", | ||
"readOnly": true | ||
}, | ||
"location": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to other location resource types in compute, I guess locations/cloudServiceOsVersions resource also uses ProxyOnly, LocationBased routing. Property 'location' cannot be used as a top level property for proxy resources.
Refer the NOTE section in the RP documentation here: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md#resource-request-properties-envelope
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that the note says that location is not applicable in the request body. However, these ProxyOnly resources are only available through GET. Additionally readonly: true is specified. So location would only be applied for the response body in this situation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As per offline discussion, as cloudServiceOsVersions are associated with a location, including location in response sounds reasonable.
…vices resource (Azure#13155) * add previous cloud service version * add 2021-03-01 version * add rdp response body * update examples * suppress error * try suppress * suppress * remove example and suppress error * add new optional allowModelOverride property * update custom words Co-authored-by: stephenhou <stehou@microsoft.com>
}, | ||
"swappableCloudService": { | ||
"$ref": "#/definitions/SubResource", | ||
"description": "The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update the description to add the bold text: "description": "The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated or deleted once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown."
}
…vices resource (Azure#13155) * add previous cloud service version * add 2021-03-01 version * add rdp response body * update examples * suppress error * try suppress * suppress * remove example and suppress error * add new optional allowModelOverride property * update custom words Co-authored-by: stephenhou <stehou@microsoft.com>
Changelog
Please ensure to add changelog with this PR by answering the following questions.
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.
Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.