Update fields description for VectorQuery #28483
Merged
openapi-pipeline-app / Swagger LintDiff
succeeded
May 6, 2024 in 3m 58s
Swagger LintDiff succeeded
Details
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-03-01-preview | package-2024-03-01-preview(659aab5) | package-2024-03-01-preview(main) |
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The host parameter must be typed 'type 'string', format 'url''. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L16 |
|
The schema 'SuggestDocumentsResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1165 |
|
The schema 'SuggestResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1189 |
|
The schema 'FacetResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1204 |
|
The schema 'AnswerResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1216 |
|
The schema 'CaptionResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1245 |
|
The schema 'SearchDocumentsResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1426 |
|
The schema 'SearchResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1503 |
|
The schema 'IndexBatch' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1565 |
|
The schema 'IndexAction' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1581 |
|
The schema 'IndexingResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1625 |
|
The schema 'IndexDocumentsResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1659 |
|
The schema 'SearchRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L2471 |
|
The schema 'SuggestRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L2625 |
|
The schema 'AutocompleteRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L2686 |
|
The schema 'AutocompleteResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L2742 |
|
The schema 'AutocompleteItem' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L2766 |
|
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L2787 |
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L6 |
|
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L7 |
|
| Path contains non-recommended characters. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L31 |
|
| 'GET' operation 'Documents_Count' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L36 |
|
| OperationId for get method should contain 'Get' or 'list' Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L36 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L63 |
|
Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L65 |
|
The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L65 |
|
| 'GET' operation 'Documents_SearchGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L77 |
|
| 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.Search/preview/2024-03-01-Preview/searchindex.json#L95 |
|
| Parameter name '$count' should not begin with '$' or '@'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L96 |
|
| Avoid the use of x-nullable. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L100 |
|
| Parameter name '$filter' should not begin with '$' or '@'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L121 |
|
| Parameter name '$orderby' should not begin with '$' or '@'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L171 |
|
| Avoid the use of x-nullable. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L213 |
|
| Avoid the use of x-nullable. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L452 |
|
| Avoid the use of x-nullable. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L482 |
|
| Parameter name '$select' should not begin with '$' or '@'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L498 |
|
| Parameter name '$skip' should not begin with '$' or '@'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L510 |
|
| Parameter name '$top' should not begin with '$' or '@'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L520 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L585 |
|
Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L587 |
|
The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L587 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L635 |
|
Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L637 |
|
The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L637 |
|
| Path contains non-recommended characters. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L644 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L660 |
|
| Parameter name '$select' should not begin with '$' or '@'. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L668 |
|
| Error response should contain a x-ms-error-code header. Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L691 |
|
Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L693 |
|
The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L693 |
Loading