[Maps - Tracking] Review request for Search to add version preview/2022-09-01-preview [Hub Generated]

[specialforest]

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your engagement record.

• Link to engagement record issue:

Is this review for (select one):

• [ ] a private preview
• [x] a public preview
• [ ] GA release

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 Open API document (swagger) if applicable, and the root paths that have been updated.}

• Design Document:https://microsoft.sharepoint.com/:w:/t/Azure-Maps/EQaM-9d6n2FNvxvZpqUJhAgBvANwf5GksWTC5wK6wOhADA?e=tCYbNm
• Previous Open API Doc:
• Updated paths: /search/polygon

❔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.

• 💬 Teams Channel
• 💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting
• Open API Hub

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Azure DevTools Wiki

[openapi-workflow-bot[bot]]

Hi, @specialforest Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

[openapi-pipeline-app[bot]]

Swagger Validation Report

️🔄BreakingChange inProgress [Detail]

️🔄Breaking Change(Cross-Version) inProgress [Detail]

️⌛CredScan pending [Detail]

️🔄LintDiff inProgress [Detail]

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️⌛ApiReadinessCheck pending [Detail]

️🔄~[Staging] ServiceAPIReadinessTest inProgress [Detail]

️🔄~[Staging] TrafficValidation inProgress [Detail]

️⌛ModelValidation pending [Detail]

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️⌛PoliCheck pending [Detail]

️🔄SDK Track2 Validation inProgress [Detail]

️🔄PrettierCheck inProgress [Detail]

️⌛SpellCheck pending [Detail]

️🔄Lint(RPaaS) inProgress [Detail]

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

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

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

[openapi-workflow-bot[bot]]

Hi @specialforest, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

[specialforest]

This is blocked by https://github.com/Azure/azure-rest-api-specs/pull/20244

[openapi-pipeline-app[bot]]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 78 Warnings warning [Detail]

compared swaggers (via Oad v0.10.1)]	new version	base version
search.json	2022-09-01-preview(5c9cc73)	1.0(main)

The following breaking changes are detected by comparison with the latest preview version:

Only 30 items are listed, please refer to log for more details.

Rule	Message
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/polygon/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L444:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/fuzzy/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L489:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/poi/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L600:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/nearby/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L689:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/poi/category/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L763:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/poi/category/tree/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L852:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/address/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L892:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/address/reverse/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L972:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/address/reverse/crossStreet/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1083:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/address/structured/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1140:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/geometry/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1254:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/alongRoute/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1328:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/fuzzy/batch/sync/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1406:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/fuzzy/batch/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1457:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/address/batch/sync/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1547:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/address/batch/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1598:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/address/reverse/batch/sync/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1687:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/search/address/reverse/batch/{format}' removed or restructured? Old: Search/preview/1.0/search.json#L1738:5
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was '202Async' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L43:3 Old: Search/preview/1.0/search.json#L52:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'SearchInsideGeometryRequest' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L485:3 Old: Search/preview/1.0/search.json#L1829:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'SearchAlongRouteRequest' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L485:3 Old: Search/preview/1.0/search.json#L1829:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'BatchRequest' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L485:3 Old: Search/preview/1.0/search.json#L1829:3
:warning: 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'BatchId' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L44:3 Old: Search/preview/1.0/search.json#L53:3
:warning: 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'LimitSearch' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L44:3 Old: Search/preview/1.0/search.json#L53:3
:warning: 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'Offset' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L44:3 Old: Search/preview/1.0/search.json#L53:3
:warning: 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'OptionalBiasLat' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L44:3 Old: Search/preview/1.0/search.json#L53:3
:warning: 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'OptionalBiasLon' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L44:3 Old: Search/preview/1.0/search.json#L53:3
:warning: 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'BoundingBoxTopLeft' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L44:3 Old: Search/preview/1.0/search.json#L53:3
:warning: 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'BoundingBoxBottomRight' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L44:3 Old: Search/preview/1.0/search.json#L53:3
:warning: 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'RequiredBiasLat' removed or renamed? New: Search/preview/2022-09-01-preview/search.json#L44:3 Old: Search/preview/1.0/search.json#L53:3

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

compared tags (via openapi-validator v1.13.0)	new version	base version
package-preview-2022-09	package-preview-2022-09(5c9cc73)	default(main)

️️✔️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.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️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.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

[ghost]

Hi, @specialforest. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

[ghost]

Hi, @specialforest. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

[ghost]

Hi, @specialforest. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

[ghost]

Hi, @specialforest. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

[ghost]

Hi, @specialforest. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.