[Hub Generated] Review request for Microsoft.AzureStackHCI to add version preview/2023-07-01-preview #24998
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
…022-12-15-preview to version 2023-07-01-preview
|
Hi, @wyatt-troia-msft! Thank you for your pull request. To help get your PR merged: Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| common.json | 2023-07-01-preview(52f765e) | 2022-12-15-preview(main) |
| galleryImages.json | 2023-07-01-preview(52f765e) | 2022-12-15-preview(main) |
| marketplaceGalleryImages.json | 2023-07-01-preview(52f765e) | 2022-12-15-preview(main) |
| networkInterfaces.json | 2023-07-01-preview(52f765e) | 2022-12-15-preview(main) |
| storageContainers.json | 2023-07-01-preview(52f765e) | 2022-12-15-preview(main) |
| virtualHardDisks.json | 2023-07-01-preview(52f765e) | 2022-12-15-preview(main) |
| virtualNetworks.json | 2023-07-01-preview(52f765e) | 2022-12-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 24 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 110 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.4) | new version | base version |
|---|---|---|
| package-preview-2023-07 | package-preview-2023-07(52f765e) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 24 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L7 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'GalleryImagesModel'. Consider using the plural form of 'GalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L42 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'GalleryImagesModel'. Consider using the plural form of 'GalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L79 |
||
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L103 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'GalleryImagesModel'. Consider using the plural form of 'GalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L134 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'GalleryImagesModel'. Consider using the plural form of 'GalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L183 |
||
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L204 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'GalleryImagesModel'. Consider using the plural form of 'GalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L239 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'GalleryImagesModel'. Consider using the plural form of 'GalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L278 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L450 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/galleryImages.json#L472 |
||
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L7 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceGalleryImagesModel'. Consider using the plural form of 'MarketplaceGalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L42 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceGalleryImagesModel'. Consider using the plural form of 'MarketplaceGalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L79 |
||
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L103 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceGalleryImagesModel'. Consider using the plural form of 'MarketplaceGalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L134 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceGalleryImagesModel'. Consider using the plural form of 'MarketplaceGalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L183 |
||
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L207 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceGalleryImagesModel'. Consider using the plural form of 'MarketplaceGalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L242 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'MarketplaceGalleryImagesModel'. Consider using the plural form of 'MarketplaceGalleryImages' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L281 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L406 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L428 |
||
| Schema should have a description or title. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/marketplaceGalleryImages.json#L559 |
||
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.AzureStackHCI/preview/2023-07-01-preview/networkInterfaces.json#L7 |
️❌Avocado: 65 Errors, 0 Warnings failed [Detail]
Only 24 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.AzureStackHCI/clusters is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2022-12-15-preview/clusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2022-12-15-preview/clusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2022-12-15-preview/clusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2022-12-15-preview/arcSettings.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2022-12-15-preview/arcSettings.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{}/extensions is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2022-12-15-preview/extensions.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{}/extensions/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2022-12-15-preview/extensions.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/galleryimages/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/galleryImages.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/galleryimages is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/galleryImages.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.AzureStackHCI/galleryimages is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/galleryImages.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/networkinterfaces/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/networkInterfaces.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/networkinterfaces is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/networkInterfaces.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.AzureStackHCI/networkinterfaces is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/networkInterfaces.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/virtualharddisks/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualHardDisks.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/virtualharddisks is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualHardDisks.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.AzureStackHCI/virtualharddisks is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualHardDisks.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/virtualmachines/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/virtualmachines/{}/start is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/virtualmachines/{}/stop is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/virtualmachines/{}/restart is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/virtualmachines is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.AzureStackHCI/virtualmachines is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/virtualnetworks/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualNetworks.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/virtualnetworks is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualNetworks.json |
️️✔️SwaggerAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @wyatt-troia-msft, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
This was referenced Jul 26, 2023
ms-zhenhua
added
Approved-Suppression
WaitForARMFeedback
@ms-zhenhua @zizw123 Can you help answer this? |
raych1
added
the
Approved-SdkBreakingChange-Go
|
I approved go bc as it's beta version and they are intended api change. |
|
Please fix the Avocado and ModelValidation failures. These are blocking the merge. |
I have removed the 200 example responses that were causing the ModelValidation failures, but the CI pipeline no longer seems to be running the automated validations. How can we fix this? The Avocado failures are due to intentionally-deprecated API paths. |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
/pr RequestMerge |
rkmanda
approved these changes
Aug 15, 2023
rkmanda
deleted the
wyatt-troia-msft-azurestackhci-Microsoft.AzureStackHCI-2023-07-01-preview
branch
This was referenced Aug 15, 2023
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 (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can request review from an ARM API Review board.
ARM API changes review
ARMReviewlabel.ARMReviewlabel, if appropriate.If this happens, proceed according to guidance given in GitHub comments also added by the automation.
Breaking change review
If you have any breaking changes as defined in the Breaking Change Policy,
follow the process outlined in the High-level Breaking Change Process doc.
Getting help
and https://aka.ms/ci-fix.