[Microsoft.AzureStackHCI] Review Request for S360 fix in 2021-09-01-preview and 2022-12-15-preview #24222
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
|
Hi, @pathuang-sia 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| virtualMachines.json | 2021-09-01-preview(6fbb7ef) | 2021-09-01-preview(main) |
| virtualMachines.json | 2022-12-15-preview(6fbb7ef) | 2022-12-15-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| package-preview-2021-09 | package-preview-2021-09(6fbb7ef) | package-preview-2021-09(main) |
| package-preview-2022-12-15 | package-preview-2022-12-15(6fbb7ef) | package-preview-2022-12-15(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| 'GET' operation 'virtualmachines_Retrieve' should use method name 'Get' or Method name start with 'List'. 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/2021-09-01-preview/virtualMachines.json#L42 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'virtualmachinesModel'. Consider using the plural form of 'virtualmachines' 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/2021-09-01-preview/virtualMachines.json#L42 |
|
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L56 |
|
| Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L78 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'virtualmachinesModel'. Consider using the plural form of 'virtualmachines' 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/2021-09-01-preview/virtualMachines.json#L79 |
|
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L102 |
|
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L108 |
|
| Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L138 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'virtualmachinesModel'. Consider using the plural form of 'virtualmachines' 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/2021-09-01-preview/virtualMachines.json#L139 |
|
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L152 |
|
| Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L174 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'virtualmachinesModel'. Consider using the plural form of 'virtualmachines' 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/2021-09-01-preview/virtualMachines.json#L175 |
|
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L188 |
|
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L194 |
|
| Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L226 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'virtualmachinesModel'. Consider using the plural form of 'virtualmachines' 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/2021-09-01-preview/virtualMachines.json#L227 |
|
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L244 |
|
| Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L268 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'virtualmachinesModel'. Consider using the plural form of 'virtualmachines' 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/2021-09-01-preview/virtualMachines.json#L269 |
|
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L286 |
|
| Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L310 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'virtualmachinesModel'. Consider using the plural form of 'virtualmachines' 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/2021-09-01-preview/virtualMachines.json#L311 |
|
| Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L328 |
|
| Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L352 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'virtualmachinesModel'. Consider using the plural form of 'virtualmachines' 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/2021-09-01-preview/virtualMachines.json#L353 |
|
| Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-09-01-preview/virtualMachines.json#L390 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'virtualmachinesModel'. Consider using the plural form of 'virtualmachines' 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/2021-09-01-preview/virtualMachines.json#L391 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridIdentityMetadataModel'. Consider using the plural form of 'HybridIdentityMetadata' 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/2021-09-01-preview/virtualMachines.json#L429 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridIdentityMetadataModel'. Consider using the plural form of 'HybridIdentityMetadata' 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/2021-09-01-preview/virtualMachines.json#L495 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HybridIdentityMetadataModel'. Consider using the plural form of 'HybridIdentityMetadata' 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/2021-09-01-preview/virtualMachines.json#L550 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
|
Hi @pathuang-sia and @arcboard, one or more change(s) have been detected in your Arc enabled VM's or Arc enabled Server's RPs. Please review the changes and ensure that no gaps have been introduced with respect to the ARM API modeling consistency across Azure Arc and Azure Compute. For further details, see guidelines at Consistency in ARM Modeling. To approve the change(s), set the label to ArcSignedOff. If you have any questions, please mail to arcboard@microsoft.com. |
|
PR based off of changes from https://github.com/Azure/azure-rest-api-specs-pr/pull/12609 (which have gone through breaking change review) to address S360 items |
This was referenced May 30, 2023
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @pathuang-sia, 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. |
@pathuang-sia Why you just modify these two api versions: "2021-09-01-preview" and "2022-12-15" in the public repo? |
2021-09-01-preview was the api-version that contain the virtualmachine resource that triggered the s360 alerts. 2022-12-15-preview inherited some of the errors, therefore need those changes as well. The other api-versions do not contain the virtualmachine resource therefore do not need the modification. |
add "Approve-BreakingChange" because it is approved in private pr |
kazrael2119
added
the
Approved-BreakingChange
|
@pathuang-sia , You should ask someone from the Arc Review Board to review this pr, beacuse "ArcReview" label is added |
justinytchen
approved these changes
Jun 1, 2023
|
Hi @kazrael2119 I went ahead and added the arcsignedoff tag since Justin from the arc-arm-api-review board reviewed it. |
tadelesh
approved these changes
Jun 6, 2023
This was referenced Jun 6, 2023
harryli0108
pushed a commit
to harryli0108/azure-rest-api-specs
that referenced
this pull request
Jul 28, 2023
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.
…2609
ARM API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[x] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.