Release search azure.search preview/2024 09 01 preview #29734
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| searchindex.json | 2024-09-01-preview(f8c8808) | 2024-07-01(main) |
| searchindex.json | 2024-09-01-preview(f8c8808) | 2024-05-01-preview(main) |
| searchservice.json | 2024-09-01-preview(f8c8808) | 2024-07-01(main) |
| searchservice.json | 2024-09-01-preview(f8c8808) | 2024-05-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 7 Errors, 93 Warnings failed [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-09-01-preview | package-2024-09-01-preview(f8c8808) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 23 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The schema 'LexicalNormalizer' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L3385 |
|
|
The schema 'CustomNormalizer' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L3406 |
|
|
The schema 'IndexerCurrentState' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L7797 |
|
|
The schema 'SearchAlias' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L8524 |
|
|
The schema 'ListAliasesResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L8599 |
|
|
The schema 'AmlSkill' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L9747 |
|
|
The schema 'SearchIndexerCache' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L12290 |
|
| Avoid the use of x-nullable. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1352 |
||
| Avoid the use of x-nullable. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1744 |
||
| Schema should have a description or title. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L2884 |
||
| Schema should have a description or title. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L2982 |
||
| Path contains non-recommended characters. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L335 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L351 |
||
| Parameter should have a description. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L358 |
||
| The body parameter is not marked as required. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L361 |
||
| 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-09-01-preview/searchservice.json#L383 |
||
| Error response should contain a x-ms-error-code header. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L403 |
||
Error schema should define code and message properties as required.Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L405 |
||
The error property in the error response schema should be required.Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L405 |
||
| Don't specify additionalProperties as a sibling of properties. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L797 |
||
| Don't specify additionalProperties as a sibling of properties. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L828 |
||
| Don't specify additionalProperties as a sibling of properties. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L834 |
||
| Don't specify additionalProperties as a sibling of properties. Location: Azure.Search/preview/2024-09-01-preview/searchservice.json#L930 |
The following errors/warnings exist before current PR submission:
Only 23 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-09-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-09-01-preview/searchindex.json#L1177 |
|
The schema 'SuggestResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1201 |
|
The schema 'FacetResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1216 |
|
The schema 'SearchDocumentsResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1228 |
|
The schema 'SearchResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1305 |
|
The schema 'IndexBatch' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1367 |
|
The schema 'IndexAction' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1383 |
|
The schema 'IndexingResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1427 |
|
The schema 'IndexDocumentsResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L1461 |
|
The schema 'SearchRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L2377 |
|
The schema 'SuggestRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L2535 |
|
The schema 'AutocompleteRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L2596 |
|
The schema 'AutocompleteResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L2652 |
|
The schema 'AutocompleteItem' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L2676 |
|
The schema 'AnswerResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L2695 |
|
The schema 'CaptionResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2024-09-01-preview/searchindex.json#L2724 |
|
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-09-01-preview/searchindex.json#L3060 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: Azure.Search/preview/2024-09-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-09-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-09-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-09-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-09-01-preview/searchservice.json#L2086 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 234 Errors, 0 Warnings failed [Detail]
Only 23 items are listed, please refer to log for more details.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌PoliCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Click detail for error messages. Exception contact vsswagger@microsoft.com or https://aka.ms/swaggersupport. |
️❌SpellCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unknown word (Matryoshka), please fix the error. See https://aka.ms/ci-fix#spell-check path: Azure.Search/preview/2024-09-01-preview/searchservice.json#L6369:337 |
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️⌛Automated merging requirements met pending [Detail]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
jonathanserbent
requested review from
arv100kri,
bleroy,
BevLoh,
giulianob and
a team
as code owners
jonathanserbent
requested review from
tg-msft and
mario-guerra
and removed request for
a team
added 9 commits
July 9, 2024 10:34
…kill swagger change
jonathanserbent
force-pushed
the
release-search-Azure.Search-preview/2024-09-01-preview
branch
from
dc477be to
f8c8808
Compare
yuuuuuuuu
reviewed
Jul 12, 2024
| "description": "The name of the kind of compression method being configured for use with vector search.", | ||
| "x-nullable": false | ||
| }, | ||
| "storeOriginalVectors": { |
There was a problem hiding this comment.
We'll postpone "HNSW Storage Optimization" to Nov. release, so please help remove "storeOriginalVectors" from 2024-09-01-preview swagger.
openapi-pipeline-app
bot
added
PipelineBotTrigger
and removed
PipelineBotTrigger
labels
openapi-pipeline-app
bot
added
PipelineBotTrigger
and removed
PipelineBotTrigger
labels
openapi-pipeline-app
bot
added
PipelineBotTrigger
and removed
PipelineBotTrigger
labels
JeffreyRichter
added
BreakingChange-Approved-BugFix
jonathanserbent
added
the
PublishToCustomers
alzimmermsft
approved these changes
Aug 5, 2024
jonathanserbent
deleted the
release-search-Azure.Search-preview/2024-09-01-preview
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
Getting help
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.