azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Search preview version 2024-03-01-preview
Data Plane API - Pull Request
Another BYOV preview
API Info: The Basics
Target Features:
- Support narrow data types for vector values and vector quantization
- Support reduction of vector field storage overhead via _source exclusions.
Next Steps to Merge
✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 22 Errors, 93 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| searchindex.json | 2024-03-01-Preview(aa18df5) | 2023-11-01(main) |
| searchindex.json | 2024-03-01-Preview(aa18df5) | 2023-10-01-Preview(main) |
| searchservice.json | 2024-03-01-Preview(aa18df5) | 2023-11-01(main) |
| searchservice.json | 2024-03-01-Preview(aa18df5) | 2023-10-01-Preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 25 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 25 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 101 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2024-03-01-preview | package-2024-03-01-preview(aa18df5) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 25 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L65 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L65 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L587 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L587 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L637 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L637 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L693 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L693 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L843 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L843 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L892 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L892 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L947 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L947 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1107 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1107 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1156 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchindex.json#L1156 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L94 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L94 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L145 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L145 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L190 |
|
| :warning: ErrorResponse | Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L190 |
|
| :warning: ErrorResponse | The error property in the error response schema should be required.Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L237 |
The following errors/warnings exist before current PR submission:
Only 25 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 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L15 |
|
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.Search/preview/2024-03-01-Preview/searchservice.json#L413 |
|
The schema 'AnalyzeRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L2031 |
|
The schema 'AnalyzeResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L2071 |
|
The schema 'AnalyzedTokenInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L2086 |
|
The schema 'LexicalAnalyzer' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L3221 |
|
The schema 'CustomAnalyzer' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-03-01-Preview/searchservice.json#L3242 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌PoliCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Click detail for error messages. Exception contact [email protected] or https://aka.ms/swaggersupport. |
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 4071071f143d5c5a232a4f477b51783fe268d0e5. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.Search.Documents [View full logs] [Preview SDK Changes]info [Changelog]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| .Net | Azure.Search.Documents | https://apiview.dev/Assemblies/Review/ce93b4e0d50e46c18296e720843a4651?revisionId=542e3638747145df90457bccbe31979f |
| Swagger | Azure.Search | https://apiview.dev/Assemblies/Review/568e072357364637890ba703eeee2c75?revisionId=75aa912427d74d6d987b760bce306bc9 |
Hi @sazeesha098! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Why the new "required" properties? These are breaking and should be avoided.
Why the new "required" properties? These are breaking and should be avoided.
Similar to other Azure services, we had to encapsulate the SearchError within an Error property. While our service successfully accomplishes this, Swagger fails to include it. For instance, the service returns:
{
"error": {
"message": "
However, Swagger only exhibits the following:
{
"message": "
@heaths, thanks for all the feedback, we have addressed it and updated this PR. Can you please add the "APIStewardshipBoard-SignedOff" tag.
cc: @jhendrixMSFT
I think @JeffreyRichter has the final call for adding APIStewardshipBoard-SignedOff