-
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.HybridCompute to add version preview/2021-06-10-preview #14797
[Hub Generated] Review request for Microsoft.HybridCompute to add version preview/2021-06-10-preview #14797
Conversation
…021-05-17-preview to version 2021-06-10-preview
Hi, @dorothyhu 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 |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2021-06-10-preview/privateLinkScopes.json#L918 |
|
'patchSettings' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L783 |
|
'patchSettings' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L793 |
|
'osProfile' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L950 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.HybridCompute/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L673 |
R4037 - MissingTypeObject |
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L706 |
R4037 - MissingTypeObject |
The schema 'OperationValue' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L719 |
R4037 - MissingTypeObject |
The schema 'OperationValueDisplay' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L738 |
R4037 - MissingTypeObject |
The schema 'OSProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L773 |
R4037 - MissingTypeObject |
The schema 'MachineProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L811 |
R4037 - MissingTypeObject |
The schema 'MachineUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L945 |
R4037 - MissingTypeObject |
The schema 'Machine' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L964 |
R4037 - MissingTypeObject |
The schema 'MachineUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L986 |
R4037 - MissingTypeObject |
The schema 'MachineListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L1003 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 4 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:preview/2021-06-10-preview/HybridCompute.json compared with base:preview/2021-05-17-preview/HybridCompute.json
- current:preview/2021-06-10-preview/privateLinkScopes.json compared with base:preview/2021-05-17-preview/privateLinkScopes.json
- current:preview/2021-06-10-preview/HybridCompute.json compared with base:stable/2021-05-20/HybridCompute.json
- current:preview/2021-06-10-preview/privateLinkScopes.json compared with base:stable/2021-05-20/privateLinkScopes.json
Rule | Message |
---|---|
1029 - ReadonlyPropertyChanged |
The read only property has changed from 'true' to 'false'. New: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L816:9 Old: Microsoft.HybridCompute/stable/2021-05-20/HybridCompute.json#L787:9 |
1029 - ReadonlyPropertyChanged |
The read only property has changed from 'true' to 'false'. New: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L773:5 Old: Microsoft.HybridCompute/stable/2021-05-20/HybridCompute.json#L763:5 |
The following breaking changes are detected by comparison with latest preview version:
Rule | Message |
---|---|
1029 - ReadonlyPropertyChanged |
The read only property has changed from 'true' to 'false'. New: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L816:9 Old: Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json#L787:9 |
1029 - ReadonlyPropertyChanged |
The read only property has changed from 'true' to 'false'. New: Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json#L773:5 Old: Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json#L763:5 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"hybridcompute/resource-manager/readme.md",
"tag":"package-preview-2021-06",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"hybridcompute/resource-manager/readme.md",
"tag":"package-preview-2021-06",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"hybridcompute/resource-manager/readme.md",
"tag":"package-preview-2021-06",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
Hi, @dorothyhu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
@dorothyhu, it seems this PR contains breaking change compared with Microsoft.HybridCompute/stable/2021-05-20, could you follow the breaking change review process for it? |
Hi @dorothyhu, 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. |
Thank you for copying the existing version into new folder for first commit. It helps in reviewing the change. Changes looks good, please follow the process given @ https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/212/Swagger-PR-Review to continue |
@lirenhe Hi Liren, I don't understand why this is a breaking change. It doesn't remove or add any properties from the previous APIs. |
@lirenhe in this case, it's not breaking change, as it 's remove readonly in a model, it's similar to add a property in the request, it's not breaking change in new version, so I removed the label |
…sion preview/2021-06-10-preview (Azure#14797) * Adds base for updating Microsoft.HybridCompute from version preview/2021-05-17-preview to version 2021-06-10-preview * Updates readme * Updates API version in new specs and examples * updated the swagger * added the missing bracket * removed type object * removed PatchSettings ref * used x-ms-client-flatten * fixed an issue * added osProfile to the machineUpdateProperties * removed the extra space * fixed by npm run prettier
…sion preview/2021-06-10-preview (Azure#14797) * Adds base for updating Microsoft.HybridCompute from version preview/2021-05-17-preview to version 2021-06-10-preview * Updates readme * Updates API version in new specs and examples * updated the swagger * added the missing bracket * removed type object * removed PatchSettings ref * used x-ms-client-flatten * fixed an issue * added osProfile to the machineUpdateProperties * removed the extra space * fixed by npm run prettier
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
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 API Review Board as defined in the Breaking Change Policy.
Please follow the link to find more details on PR review process.