[Hub Generated] Review request for Microsoft.AzureStackHCI to add version preview/2023-09-01-preview #25555
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
…023-07-01-preview to version 2023-09-01
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| common.json | 2023-09-01-preview(cf031b5) | 2023-07-01-preview(main) |
| galleryImages.json | 2023-09-01-preview(cf031b5) | 2023-07-01-preview(main) |
| marketplaceGalleryImages.json | 2023-09-01-preview(cf031b5) | 2023-07-01-preview(main) |
| networkInterfaces.json | 2023-09-01-preview(cf031b5) | 2023-07-01-preview(main) |
| storageContainers.json | 2023-09-01-preview(cf031b5) | 2023-07-01-preview(main) |
| virtualHardDisks.json | 2023-09-01-preview(cf031b5) | 2023-07-01-preview(main) |
| virtualMachineInstances.json | 2023-09-01-preview(cf031b5) | 2023-07-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 290 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-preview-2023-09 | package-preview-2023-09(cf031b5) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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-09-01-preview/galleryImages.json#L39 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L48 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L51 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L57 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L64 |
||
| 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-09-01-preview/galleryImages.json#L76 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L89 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L92 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L98 |
||
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L100 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L113 |
||
| 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-09-01-preview/galleryImages.json#L131 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L144 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L147 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L153 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L160 |
||
| 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-09-01-preview/galleryImages.json#L177 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L190 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L193 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L199 |
||
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L201 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L214 |
||
| 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-09-01-preview/galleryImages.json#L236 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L245 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L248 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L251 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L258 |
||
| 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-09-01-preview/galleryImages.json#L275 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L284 |
||
| Use the latest version v5 of types.json. Location: Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json#L287 |
️❌Avocado: 75 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The JSON file is not found but it is referenced from the readme file. readme: specification/azurestackhci/resource-manager/readme.md json: [Microsoft.AzureStackHCI/stable/2023-08-01/updates.json ](https://github.com/Azure/azure-rest-api-specs/blob/cf031b573ccf9c53ab722772742533ac5bd77efa/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-08-01/updates.json) |
|
The example JSON file is not referenced from the swagger file. readme: specification/azurestackhci/resource-manager/readme.md json: stable/2023-08-01/examples/DeleteUpdates.json |
|
The example JSON file is not referenced from the swagger file. readme: specification/azurestackhci/resource-manager/readme.md json: stable/2023-08-01/examples/GetUpdates.json |
|
The example JSON file is not referenced from the swagger file. readme: specification/azurestackhci/resource-manager/readme.md json: stable/2023-08-01/examples/ListUpdates.json |
|
The example JSON file is not referenced from the swagger file. readme: specification/azurestackhci/resource-manager/readme.md json: stable/2023-08-01/examples/PostUpdates.json |
|
The example JSON file is not referenced from the swagger file. readme: specification/azurestackhci/resource-manager/readme.md json: stable/2023-08-01/examples/PutUpdates.json |
|
The swagger JSON file is not referenced from the readme file. readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/stable/2023-08-01/updates.json |
|
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 |
️️✔️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
|
AzureRestAPISpecReview
added
ARMReview
WaitForARMFeedback
...zurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-09-01/logicalNetworks.json
Outdated
Show resolved
Hide resolved
...hci/resource-manager/Microsoft.AzureStackHCI/stable/2023-09-01/marketplaceGalleryImages.json
Outdated
Show resolved
Hide resolved
...restackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-09-01/networkInterfaces.json
Outdated
Show resolved
Hide resolved
added 2 commits
September 28, 2023 15:54
|
Note: we have renamed the api-version to a preview version under the guidance of the breaking change committee |
raych1
added
the
Approved-SdkBreakingChange-Go
|
The breaking change for Go is not brought in by this PR. |
…to pathuang-sia-azurestackhci-Microsoft.AzureStackHCI-2023-09-01
pathuang-sia
changed the title
|
please fix the error code in lint-diff https://github.com/Azure/azure-rest-api-specs/pull/25555/checks?check_run_id=17531976023, then re-add MergeRequested |
|
@ms-zhenhua We believe the DefinitionPropertiesNameCamelCase error is false positive. The rule indicates that if it is a two letter acronym it should be capitalized like how we did: https://github.com/Azure/azure-openapi-validator/blob/main/docs/definitions-properties-names-camel-case.md Can we bypass this error and merge the PR? |
@pathuang-sia I think you are right. Could you kindly follow Swagger-Suppression-Process to suppress DefinitionsPropertiesNamesCamelCase to fix Automated merging requirements met ? After that, please re-add MergeRequested label for merging. Thanks. |
ms-zhenhua
approved these changes
Oct 12, 2023
ms-zhenhua
deleted the
pathuang-sia-azurestackhci-Microsoft.AzureStackHCI-2023-09-01
branch
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This was referenced Oct 12, 2023
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
…sion preview/2023-09-01-preview (#25555) * Adds base for updating Microsoft.AzureStackHCI from version preview/2023-07-01-preview to version 2023-09-01 * Updates readme * Updates API version in new specs and examples * update 2023-09-01 from Azure/azure-rest-api-specs-pr#14245 * add suppressions from cluster resources * remove suppressions from cluster team as some of the files don't exist yet * remove name redundancy in definitions, remove x-ms-client-flatten in gateway * remove suppression GetCollectionOnlyHasValueAndNextLink * remove x-ms-code-generation-settings from resource files since the client name is already set in the title lin in readme file according to docs: https://github.com/Azure/azure-openapi-validator/blob/main/docs/deprecated-xms-code-generation-setting.md * pick up changes from Azure/azure-rest-api-specs-pr#14872 * pick up changes from Azure/azure-rest-api-specs-pr#15062 * fix routetable properties to readonly and correct name according to https://github.com/Azure/azure-rest-api-specs-pr/blob/9b0cab3710aa58519c6aa9e11f350b22e0fc3dc9/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/routeTable.json#L707 * fix property description * updating 2023-09-01 to 2023-09-01-preview according to breaking change committee guidance * remove 200 response from LRO delete * add suppression as requested reviewer --------- Co-authored-by: Patricia Huang <pathuang@pathuang-dev>
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.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.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 proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.