[AutoSuggest] Add AutoSuggest API for Azure Maps scenario #29669
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 |
|---|---|---|
| search.json | 2024-07-01-preview(c2b6b79) | 2023-06-01(main) |
| search.json | 2024-07-01-preview(c2b6b79) | 2024-04-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
| The new version is adding a path that was not found in the old version. New: Search/preview/2024-07-01-preview/search.json#L469:5 |
|
| The new version is adding a path that was not found in the old version. New: Search/preview/2024-07-01-preview/search.json#L718:5 |
|
| The new version is adding a path that was not found in the old version. New: Search/preview/2024-07-01-preview/search.json#L778:5 |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version is adding a path that was not found in the old version. New: Search/preview/2024-07-01-preview/search.json#L778:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 8 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-07 | package-preview-2024-07(c2b6b79) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Based on the response model schema, operation 'Search_GetAutosuggest' might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-07-01-preview/search.json#L779 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-07-01-preview/search.json#L779 |
||
The error property in the error response schema should be required.Location: Search/preview/2024-07-01-preview/search.json#L871 |
||
Error schema should define code and message properties as required.Location: Search/preview/2024-07-01-preview/search.json#L871 |
||
| Error response should contain a x-ms-error-code header. Location: Search/preview/2024-07-01-preview/search.json#L871 |
||
| Property should have a description. Location: Search/preview/2024-07-01-preview/search.json#L905 |
||
| Schema should have a description or title. Location: Search/preview/2024-07-01-preview/search.json#L916 |
||
| Property should have a description. Location: Search/preview/2024-07-01-preview/search.json#L919 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-07-01-preview/search.json#L289 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-07-01-preview/search.json#L403 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-07-01-preview/search.json#L403 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-07-01-preview/search.json#L418 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-07-01-preview/search.json#L455 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-07-01-preview/search.json#L455 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-07-01-preview/search.json#L515 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-07-01-preview/search.json#L515 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-07-01-preview/search.json#L585 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-07-01-preview/search.json#L585 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-07-01-preview/search.json#L600 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-07-01-preview/search.json#L652 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-07-01-preview/search.json#L652 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-07-01-preview/search.json#L667 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-07-01-preview/search.json#L704 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-07-01-preview/search.json#L704 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-07-01-preview/search.json#L764 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-07-01-preview/search.json#L764 |
|
| Schema should have a description or title. Location: Search/preview/2024-07-01-preview/search.json#L879 |
|
| Schema should have a description or title. Location: Search/preview/2024-07-01-preview/search.json#L1234 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Search/preview/2024-07-01-preview/search.json#L1259 |
|
| Schema should have a description or title. Location: Search/preview/2024-07-01-preview/search.json#L1287 |
|
| Schema should have a description or title. Location: Search/preview/2024-07-01-preview/search.json#L1293 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Search/preview/2024-07-01-preview/search.json#L1316 |
|
| Property should have a description. Location: Search/preview/2024-07-01-preview/search.json#L1316 |
|
| Property should have a description. Location: Search/preview/2024-07-01-preview/search.json#L1318 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Search/preview/2024-07-01-preview/search.json#L1400 |
|
| Property should have a description. Location: Search/preview/2024-07-01-preview/search.json#L1400 |
️️✔️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 succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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
|
Generated ApiView
|
winest
force-pushed
the
feature/billyhung/am_autosuggest
branch
from
e6b0989
to
c2b6b79
Compare
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.