New Azure Cognitive Search API version 2023-07-01-Preview #23779
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
Careyjmac
requested review from
DominikMe and
weidongxu-microsoft
and removed request for
a team
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| searchindex.json | 2023-07-01-Preview(303bf71) | 2019-05-06(main) |
| searchindex.json | 2023-07-01-Preview(303bf71) | 2021-04-30-Preview(main) |
| searchservice.json | 2023-07-01-Preview(303bf71) | 2019-05-06(main) |
| searchservice.json | 2023-07-01-Preview(303bf71) | 2021-04-30-Preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 21 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.1) | new version | base version |
|---|---|---|
| package-2023-07-01-preview | package-2023-07-01-preview(303bf71) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
Only 30 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/2023-07-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/2023-07-01-Preview/searchindex.json#L1156 |
|
Property 'value' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1156 |
|
The schema 'SuggestResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1180 |
|
Property '@search.text' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1180 |
|
The schema 'FacetResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1195 |
|
The schema 'AnswerResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1207 |
|
The schema 'CaptionResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1235 |
|
The schema 'SearchDocumentsResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1415 |
|
Property 'value' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1415 |
|
The schema 'SearchResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1492 |
|
Property '@search.score' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1492 |
|
The schema 'IndexBatch' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1554 |
|
The schema 'IndexAction' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1570 |
|
The schema 'IndexingResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1614 |
|
Property 'key' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1614 |
|
Property 'status' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1614 |
|
Property 'statusCode' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1614 |
|
The schema 'IndexDocumentsResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1648 |
|
Property 'value' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1648 |
|
The schema 'SearchRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2360 |
|
The schema 'SuggestRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2503 |
|
The schema 'AutocompleteRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2564 |
|
The schema 'AutocompleteResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2620 |
|
Property 'value' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2620 |
|
The schema 'AutocompleteItem' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2644 |
|
Property 'text' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2644 |
|
Property 'queryPlusText' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2644 |
|
The schema 'SearchError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2663 |
|
Property 'message' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2663 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️🔄PoliCheck inProgress [Detail]
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Hi, @Careyjmac Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @Careyjmac, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
|
Hi, @Careyjmac, 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. Or you could onboard API spec pipeline |
|
Hi @Careyjmac, Your PR has some issues. Please fix the CI sequentially by following the order of
|
BevLoh
reviewed
May 1, 2023
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchindex.json
Outdated
Show resolved
Hide resolved
tg-msft
approved these changes
May 3, 2023
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json
Outdated
Show resolved
Hide resolved
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json
Outdated
Show resolved
Hide resolved
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json
Outdated
Show resolved
Hide resolved
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json
Show resolved
Hide resolved
tg-msft
added
the
Approved-BreakingChange
|
These changes were discussed with and approved by the API Stewardship Board. I looked through the searchservice.json diff and the searchindex.json diff to verify there are no actual breaking changes, aside from the deprecated skills. The official deprecation process has already begun for those so I'm adding the Approved-Breaking Change label. |
|
Hi @Careyjmac, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
tg-msft
approved these changes
May 4, 2023
weidongxu-microsoft
approved these changes
May 4, 2023
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchindex.json
Show resolved
Hide resolved
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json
Show resolved
Hide resolved
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json
Show resolved
Hide resolved
tg-msft
removed
BreakingChangeReviewRequired
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
tg-msft
approved these changes
May 4, 2023
There was a problem hiding this comment.
Everything looks great to me. The last fixes to make the spec more accurate for what the service does look correct and are not breaking changes. The only suppressions added were removed in later commits so that's fine too. The policheck errors need to be surpressed, but are blocked on Azure/azure-sdk-tools#6091. This is ready to merge.
This was referenced Jun 15, 2023
3 tasks
3 tasks
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 - Pull Request
Introducing new preview Azure Cognitive Search data plane API version 2023-07-01-Preview. This version includes the following changes from the previous 2021-04-30-Preview API version:
See the private PR for a better diff.
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.
❔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