-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New Azure Cognitive Search API version 2023-07-01-Preview #23779
Conversation
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 |
---|---|
HostParametersValidation |
The host parameter must be typed 'type 'string', format 'url''. Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L16 |
MissingTypeObject |
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 |
RequiredReadOnlyProperties |
Property 'value' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1156 |
MissingTypeObject |
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 |
RequiredReadOnlyProperties |
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 |
MissingTypeObject |
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 |
MissingTypeObject |
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 |
MissingTypeObject |
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 |
MissingTypeObject |
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 |
RequiredReadOnlyProperties |
Property 'value' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1415 |
MissingTypeObject |
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 |
RequiredReadOnlyProperties |
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 |
MissingTypeObject |
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 |
MissingTypeObject |
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 |
MissingTypeObject |
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 |
RequiredReadOnlyProperties |
Property 'key' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1614 |
RequiredReadOnlyProperties |
Property 'status' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1614 |
RequiredReadOnlyProperties |
Property 'statusCode' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1614 |
MissingTypeObject |
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 |
RequiredReadOnlyProperties |
Property 'value' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L1648 |
MissingTypeObject |
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 |
MissingTypeObject |
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 |
MissingTypeObject |
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 |
MissingTypeObject |
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 |
RequiredReadOnlyProperties |
Property 'value' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2620 |
MissingTypeObject |
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 |
RequiredReadOnlyProperties |
Property 'text' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2644 |
RequiredReadOnlyProperties |
Property 'queryPlusText' is a required property. It should not be marked as 'readonly' Location: Azure.Search/preview/2023-07-01-Preview/searchindex.json#L2644 |
MissingTypeObject |
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 |
RequiredReadOnlyProperties |
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
|
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
|
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchindex.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
Outdated
Show resolved
Hide resolved
specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json
Show resolved
Hide resolved
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. |
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
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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