-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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 + S360] Review request for Microsoft.SqlVirtualMachine to add version preview/2022-07-01-preview #21564
Conversation
…ew/2022-02-01-preview to version 2022-07-01-preview
…07-01-preview' of https://github.com/yareyes/azure-rest-api-specs into dev-sqlvirtualmachine-Microsoft.SqlVirtualMachine-2022-07-01-preview
Swagger Validation Report
|
compared swaggers (via Oad v0.10.2)] | new version | base version |
---|---|---|
sqlvm.json | 2022-07-01-preview(967774f) | 2022-07-01-preview(main) |
Rule | Message |
---|---|
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1693:9 Old: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1654:9 |
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1761:9 Old: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1720:9 |
️️✔️
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.0.0) | new version | base version |
---|---|---|
package-preview-2022-07 | package-preview-2022-07(967774f) | package-preview-2022-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 |
---|---|
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L19 |
ResourceNameRestriction |
The resource name parameter 'availabilityGroupListenerName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L19 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L206 |
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/2022-07-01-preview/sqlvm.json#L267 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L285 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L473 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L570 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L652 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L653 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L684 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L696 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L697 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L728 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L740 |
PatchIdentityProperty |
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L934 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L950 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1026 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1266 |
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/2022-07-01-preview/sqlvm.json#L1617 |
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/2022-07-01-preview/sqlvm.json#L1635 |
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/2022-07-01-preview/sqlvm.json#L75 |
|
The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L653 |
|
The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L697 |
|
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/2022-07-01-preview/sqlvm.json#L1041 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1315 |
|
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/2022-07-01-preview/sqlvm.json#L1761 |
|
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/2022-07-01-preview/sqlvm.json#L1790 |
|
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/2022-07-01-preview/sqlvm.json#L1828 |
|
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/2022-07-01-preview/sqlvm.json#L1832 |
|
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/2022-07-01-preview/sqlvm.json#L1865 |
️️✔️
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.
️️✔️
~[Staging] SwaggerAPIView 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.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Hi, @yareyes 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 Generation Artifacts
|
Generated ApiView
|
Hi @yareyes, 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. |
No pipelines are associated with this pull request. |
No pipelines are associated with this pull request. |
1 similar comment
No pipelines are associated with this pull request. |
@xiaoxuqi-ms Could you please help me review this PR? Thanks |
Hi @yareyes , please reach out to breaking change review board for the breaking changes first. |
Hello @xiaoxuqi-ms, I've got the approval from breaking change. Can you please help me review this? |
…or Microsoft.SqlVirtualMachine to add version preview/2022-07-01-preview (#2681) Create to sync Azure/azure-rest-api-specs#21564 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/sqlvirtualmachine?expand=1)
… to add version preview/2022-07-01-preview (Azure#21564) * Adds base for updating Microsoft.SqlVirtualMachine from version preview/2022-02-01-preview to version 2022-07-01-preview * Updates readme * Updates API version in new specs and examples * Updating swagger to latest api * Add default values for optional parameters * Adding default to optional parameters * Fixing ModelValidator * Adding long running options * Update response to async * Removing headers * Adding headers for deletion * Updating location for Post * Added prettier check * Reverted changes from error codes * Removing the location from POST
… to add version preview/2022-07-01-preview (Azure#21564) * Adds base for updating Microsoft.SqlVirtualMachine from version preview/2022-02-01-preview to version 2022-07-01-preview * Updates readme * Updates API version in new specs and examples * Updating swagger to latest api * Add default values for optional parameters * Adding default to optional parameters * Fixing ModelValidator * Adding long running options * Update response to async * Removing headers * Adding headers for deletion * Updating location for Post * Added prettier check * Reverted changes from error codes * Removing the location from POST
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:
What's the purpose of the update?
Please note we wanted to solve this s360 error: [https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=80337B3E-3B97-47D2-8879-6BCBCCBE59C8] which requires two features to add the default values.
The other changes made were lintDiff errors that broke the code, so adding them.
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.