Azure SDK Review Changes#33408
Merged
Merged
This check has been archived and is scheduled for deletion.
Learn more about checks retention
openapi-pipeline-app / Swagger LintDiff
succeeded
May 14, 2025 in 3m 40s
Swagger LintDiff succeeded
Details
| Compared specs (v2.2.3) | new version | base version |
|---|---|---|
| package-2024-07.20.0-preview | package-2024-07.20.0-preview(60b5a7d) | package-2024-07.20.0-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 50 items are listed, please refer to log for more details.
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L1465 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L1697 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L1838 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L3788 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L4592 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L5236 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L6032 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L7962 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L8076 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L8835 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L8976 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L9117 |
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L5 |
|
| Security definition should have a description. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L45 |
|
| 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: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L106 |
|
value property in pageable response should be requiredLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L139 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L162 |
|
Error response schema should contain an object property named error.Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L164 |
|
| Based on the response model schema, operation 'Applications_GetApplication' might be pageable. Consider adding the x-ms-pageable extension. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L180 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L180 |
|
| 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: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L207 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L225 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L259 |
|
Error response schema should contain an object property named error.Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L261 |
|
| The summary and description values should not be same. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L274 |
|
| 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: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L301 |
|
| Parameter name '$filter' should not begin with '$' or '@'. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L331 |
|
| Parameter name '$select' should not begin with '$' or '@'. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L339 |
|
value property in pageable response should be requiredLocation: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L354 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L377 |
|
Error response schema should contain an object property named error.Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L379 |
|
| The summary and description values should not be same. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L394 |
|
| 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: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L424 |
|
| Using post for a create operation is discouraged. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L453 |
|
| All success responses except 202 & 204 should define a response body. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L453 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L479 |
|
Error response schema should contain an object property named error.Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L481 |
|
| Path contains non-recommended characters. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L494 |
|
| 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: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L521 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L539 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L546 |
|
| Parameter name '$select' should not begin with '$' or '@'. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L554 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L592 |
|
Error response schema should contain an object property named error.Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L594 |
|
| 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: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L633 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L651 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L658 |
|
| A 202 response should include an Operation-Location response header. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L669 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L689 |
|
Error response schema should contain an object property named error.Location: Azure.Batch/preview/2024-07-01.20.0/BatchService.json#L691 |
Loading