-
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.AzureStackHCI to add version preview/2021-07-01-preview #25288
[Hub Generated] Review request for Microsoft.AzureStackHCI to add version preview/2021-07-01-preview #25288
Conversation
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
virtualMachines.json | 2021-07-01-preview(fa4d958) | 2021-07-01-preview(main) |
Rule | Message |
---|---|
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L417:13 Old: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L417:13 |
️️✔️
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.4) | new version | base version |
---|---|---|
package-preview-2021-07 | package-preview-2021-07(fa4d958) | package-preview-2021-07(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualmachines/{virtualmachinesName}' Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L37 |
ResourceNameRestriction |
The resource name parameter 'virtualmachinesName' should be defined with a 'pattern' restriction. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L37 |
PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualmachines/{virtualmachinesName}/start' Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L209 |
ResourceNameRestriction |
The resource name parameter 'virtualmachinesName' should be defined with a 'pattern' restriction. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L209 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L210 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L245 |
PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualmachines/{virtualmachinesName}/stop' Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L251 |
ResourceNameRestriction |
The resource name parameter 'virtualmachinesName' should be defined with a 'pattern' restriction. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L251 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L252 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L287 |
PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualmachines/{virtualmachinesName}/restart' Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L293 |
ResourceNameRestriction |
The resource name parameter 'virtualmachinesName' should be defined with a 'pattern' restriction. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L293 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L294 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L329 |
PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualmachines' Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L335 |
PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/virtualmachines' Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L373 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L626 |
The API version:2021-07-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L6 |
|
Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L38 |
|
'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-07-01-preview/virtualMachines.json#L39 |
|
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-07-01-preview/virtualMachines.json#L39 |
|
Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L52 |
|
Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L74 |
|
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-07-01-preview/virtualMachines.json#L75 |
|
Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L92 |
|
Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L98 |
|
Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L128 |
|
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-07-01-preview/virtualMachines.json#L129 |
|
Parameter should have a description. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L142 |
|
Operation should have a summary or description. Location: Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json#L164 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
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]
Hi, @pathuang-sia! 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 Generation Artifacts
|
Generated ApiView
|
Please address or respond to feedback from the ARM API reviewer. |
Hi @pathuang-sia! The automation detected breaking changes in this pull request. As a result, it added the
|
Next Steps to Merge |
this js breaking is not caused by this pr |
/pr RequestMerge |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
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] public repo review queue, private repo review queue
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
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to 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
If you need further help with anything, see
Getting help
section 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)
ARMReview
label.Getting help
and https://aka.ms/ci-fix.