-
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.SqlVirtualMachine to add version preview/2023-01-01-preview #23469
[Hub Generated] Review request for Microsoft.SqlVirtualMachine to add version preview/2023-01-01-preview #23469
Conversation
…ew/2022-08-01-preview to version 2023-01-01-preview
Hi, @lingxiao-microsoft 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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
sqlvm.json | 2023-01-01-preview(bf542d6) | 2022-02-01(main) |
sqlvm.json | 2023-01-01-preview(bf542d6) | 2022-08-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 4 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-preview-2023-01 | package-preview-2023-01(bf542d6) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1584 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2169 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2408 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2463 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L19 |
ResourceNameRestriction |
The resource name parameter 'availabilityGroupListenerName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L19 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L215 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.SqlVirtualMachine/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L279 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L300 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L497 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L603 |
PatchIdentityProperty |
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L980 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L996 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1382 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1741 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1759 |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'AvailabilityGroupListeners_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L78 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1157 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1431 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1890 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1919 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1957 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1961 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L1994 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2063 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2135 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2220 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2231 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2235 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2339 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2358 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2372 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2376 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2443 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 9 Errors, 0 Warnings failed [Detail]
Tag package-preview-2023-01; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 21, untested: 0, failed: 9, passed: 12
Service API Readiness Test failed. Check pipeline artifact for detail report.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceDoesNotExist, errorMessage: Resource '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-qdZeJM-23469/providers/Microsoft.Compute/virtualMachines/sqlvirtuxbr1pl' does not exist. Source: runtime OperationId: SqlVirtualMachines_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.SqlVirtualMachine/SqlVirtualMachines/sqlvirtuxbr1pl' under resource group 'apiTest-qdZeJM-23469' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SqlVirtualMachines_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.SqlVirtualMachine/SqlVirtualMachines/sqlvirtuxbr1pl' under resource group 'apiTest-qdZeJM-23469' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SqlVirtualMachines_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.SqlVirtualMachine/SqlVirtualMachines/sqlvirtuxbr1pl' under resource group 'apiTest-qdZeJM-23469' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SqlVirtualMachines_Redeploy |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.SqlVirtualMachine/SqlVirtualMachines/sqlvirtuxbr1pl' under resource group 'apiTest-qdZeJM-23469' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SqlVirtualMachines_StartAssessment |
CLIENT_ERROR |
statusCode: 400, errorCode: SqlVmNotInGroup, errorMessage: SqlVirtualMachine '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-qdZeJM-23469/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2' is not part of the SQL virtual machine group 'sqlvirtu6zuy5f'. Source: runtime OperationId: AvailabilityGroupListeners_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The requested resource of type 'Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners' with name 'availabi3jywr9' was not found. Source: runtime OperationId: AvailabilityGroupListeners_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.SqlVirtualMachine/SqlVirtualMachines/sqlvirtuxbr1pl' under resource group 'apiTest-qdZeJM-23469' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SqlVirtualMachineTroubleshoot_Troubleshoot |
CLIENT_ERROR |
statusCode: 400, errorCode: SqlVmGroupDoesNotHaveAGListener, errorMessage: SQL virtual machine group 'subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-qdZeJM-23469/providers/Microsoft.SqlVirtualMachine/SqlVirtualMachineGroups/sqlvirtu6zuy5f' does not have availability group listener 'availabi3jywr9'. Source: runtime OperationId: AvailabilityGroupListeners_Delete |
️️✔️
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
|
Hi @lingxiao-microsoft, 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. |
/azp run unifiedPipeline |
Hello @chunyu3, could you please take a look and let me know what else is needed from my side? Thank you Please see above for all passed validations |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Breaking change 1036-constraintChange has been approved in #21422. So approve for this PR. |
...almachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json
Show resolved
Hide resolved
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
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.
-[ ] 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.
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.