-
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
Fix sqlvm.json #24248
Fix sqlvm.json #24248
Conversation
Hi, @msyyc 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(21db649) | 2023-01-01-preview(main) |
Rule | Message |
---|---|
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2169:9 Old: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L2169: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.1.2) | new version | base version |
---|---|---|
package-preview-2023-01 | package-preview-2023-01(21db649) | package-preview-2023-01(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/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 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L26 |
PutRequestResponseSchemeArm |
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 |
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 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L280 |
ResourceNameRestriction |
The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L300 |
PatchResponseCode |
LRO PATCH must have 200 and 202 return codes. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L464 |
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 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L692 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L743 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L800 |
PatchResponseCode |
LRO PATCH must have 200 and 202 return codes. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L967 |
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 |
Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L26 |
|
Not using the common-types defined parameter 'api-version'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L26 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L26 |
|
Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L84 |
|
Not using the common-types defined parameter 'api-version'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L84 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L84 |
|
Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L157 |
|
Not using the common-types defined parameter 'api-version'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L157 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L157 |
|
200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.SqlVirtualMachine/preview/2023-01-01-preview/sqlvm.json#L183 |
️️✔️
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
|
Hi @msyyc, 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. |
Fix for https://github.com/Azure/sdk-release-request/issues/4213