Updating api summaries for discovery services#33828
Merged
weidongxu-microsoft merged 17 commits intoJun 4, 2025
Merged
openapi-pipeline-app / Swagger LintDiff
completed
Jun 3, 2025 in 2m 31s
Swagger LintDiff failed
LintDiff: 12 Errors, 173 Warnings
The check status is neutral due to the check being suppressed by the label Approved-LintDiff.
View Azure DevOps build log for more details.
Details
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
"tag":"package-2023-05-01-preview", "details":"Process() cancelled due to failure" |
|
|
"tag":"package-2023-05-01-preview", "details":"!Error: Operation response '/paths/ |
|
|
"tag":"package-2023-05-01-preview", "details":"stack: Error: Operation response '/paths/ |
|
|
"tag":"package-2023-05-01-preview", "details":"Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing." |
|
|
"tag":"package-2023-01-01-preview", "details":"Process() cancelled due to failure" |
|
|
"tag":"package-2023-01-01-preview", "details":"!Error: Operation response '/paths/ |
|
|
"tag":"package-2023-01-01-preview", "details":"stack: Error: Operation response '/paths/ |
|
|
"tag":"package-2023-01-01-preview", "details":"Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing." |
|
|
"tag":"package-2023-01-01-preview", "details":"Process() cancelled due to failure" |
|
|
"tag":"package-2023-01-01-preview", "details":"!Error: $ref to original location 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/marketplacecatalog/data-plane/Search/preview/2023-01-01-preview/search.json#/definitions/AzureBenefit' is not found in the new refs collection" |
|
|
"tag":"package-2023-01-01-preview", "details":"stack: Error: $ref to original location 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/marketplacecatalog/data-plane/Search/preview/2023-01-01-preview/search.json#/definitions/AzureBenefit' is not found in the new refs collection at Deduplicator.updateRefs (/home/cloudtest/.autorest/@autorest_core@3.10.7/node_modules/@autorest/core/dist/src_lib_autorest-core_ts.js:9495:31) at Deduplicator.updateRefs (/home/cloudtest/.autorest/@autorest_core@3.10.7/node_modules/@autorest/core/dist/src_lib_autorest-core_ts.js:9499:22) at Deduplicator.updateRefs (/home/cloudtest/.autorest/@autorest_core@3.10.7/node_modules/@autorest/core/dist/src_lib_autorest-core_ts.js:9499:22) at Deduplicator.updateRefs (/home/cloudtest/.autorest/@autorest_core@3.10.7/node_modules/@autorest/core/dist/src_lib_autorest-core_ts.js:9499:22) at Deduplicator.deduplicateComponent (/home/cloudtest/.autorest/@autorest_core@3.10.7/node_modules/@autorest/core/dist/src_lib_autorest-core_ts.js:9427:42) at runNextTicks (node:i" |
|
|
"tag":"package-2023-01-01-preview", "details":"Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing." |
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
Error response schema should contain an object property named error.Location: Search/preview/2023-01-01-preview/search.json#L349 |
|
Error response schema should contain an object property named error.Location: Search/preview/2023-01-01-preview/search.json#L758 |
|
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Search/preview/2023-01-01-preview/search.json#L772 |
|
| Based on the response model schema, operation 'Suggestions_GetProducts' might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2023-01-01-preview/search.json#L772 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2023-01-01-preview/search.json#L772 |
|
Error response schema should contain an object property named error.Location: Search/preview/2023-01-01-preview/search.json#L1090 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1146 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1579 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1594 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1602 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1614 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1691 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1769 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1777 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1785 |
|
| 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: Search/preview/2023-01-01-preview/search.json#L1812 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1842 |
|
| 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: Search/preview/2023-01-01-preview/search.json#L1854 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1912 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1973 |
|
| Property should have a defined type. Location: Search/preview/2023-01-01-preview/search.json#L1993 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Products/preview/2023-01-01-preview/products.json#L28 |
|
| 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: Products/preview/2023-01-01-preview/products.json#L57 |
|
| header parameter name 'X-API-Key' should be kebab case. Location: Products/preview/2023-01-01-preview/products.json#L76 |
|
| Schema with type: number should specify format Location: Products/preview/2023-01-01-preview/products.json#L85 |
|
| Schema with type: number should specify format Location: Products/preview/2023-01-01-preview/products.json#L85 |
|
| Based on the response model schema, operation 'PublicProducts_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Products/preview/2023-01-01-preview/products.json#L105 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Products/preview/2023-01-01-preview/products.json#L105 |
|
| header parameter name 'X-API-Key' should be kebab case. Location: Products/preview/2023-01-01-preview/products.json#L189 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L291 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L306 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L314 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L326 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L392 |
|
| 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: Products/preview/2023-01-01-preview/products.json#L430 |
|
| 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: Products/preview/2023-01-01-preview/products.json#L446 |
|
| 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: Products/preview/2023-01-01-preview/products.json#L450 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L454 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L462 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L478 |
|
| 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: Products/preview/2023-01-01-preview/products.json#L563 |
|
| 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: Products/preview/2023-01-01-preview/products.json#L571 |
|
| 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: Products/preview/2023-01-01-preview/products.json#L575 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L743 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L751 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L759 |
|
| 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: Products/preview/2023-01-01-preview/products.json#L786 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L816 |
|
| 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: Products/preview/2023-01-01-preview/products.json#L828 |
|
| Property should have a defined type. Location: Products/preview/2023-01-01-preview/products.json#L885 |
Loading