azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Published 20 hours ago • verified publisher icon Azure

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

Open rishikaparashar opened this issue 2 years ago • 7 comments

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:
  • Previous Open API Doc:
  • Updated paths:

❔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

rishikaparashar avatar Dec 14 '22 23:12 rishikaparashar

Hi, @rishikaparashar 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-workflow-bot[bot] avatar Dec 14 '22 23:12 openapi-workflow-bot[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.2)] new version base version
    search.json 2022-09-01-preview(8eae6a3) 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: 20 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-preview-2022-09 package-preview-2022-09(8eae6a3) default(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    :warning: PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: Search/preview/2022-09-01-preview/search.json#L224
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Search/preview/2022-09-01-preview/search.json#L370
    :warning: ErrorResponse The error property in the error response schema should be required.
    Location: Search/preview/2022-09-01-preview/search.json#L370
    :warning: ErrorResponse Error schema should define code and message properties as required.
    Location: Search/preview/2022-09-01-preview/search.json#L370
    :warning: PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: Search/preview/2022-09-01-preview/search.json#L377
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Search/preview/2022-09-01-preview/search.json#L418
    :warning: ErrorResponse The error property in the error response schema should be required.
    Location: Search/preview/2022-09-01-preview/search.json#L418
    :warning: ErrorResponse Error schema should define code and message properties as required.
    Location: Search/preview/2022-09-01-preview/search.json#L418
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Search/preview/2022-09-01-preview/search.json#L478
    :warning: ErrorResponse The error property in the error response schema should be required.
    Location: Search/preview/2022-09-01-preview/search.json#L478
    :warning: ErrorResponse Error schema should define code and message properties as required.
    Location: Search/preview/2022-09-01-preview/search.json#L478
    :warning: SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Search/preview/2022-09-01-preview/search.json#L486
    :warning: SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Search/preview/2022-09-01-preview/search.json#L661
    :warning: SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Search/preview/2022-09-01-preview/search.json#L711
    :warning: SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Search/preview/2022-09-01-preview/search.json#L717
    :warning: PropertyDescription Property should have a description.
    Location: Search/preview/2022-09-01-preview/search.json#L740
    :warning: AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Search/preview/2022-09-01-preview/search.json#L743
    :warning: PropertyDescription Property should have a description.
    Location: Search/preview/2022-09-01-preview/search.json#L743
    :warning: PropertyDescription Property should have a description.
    Location: Search/preview/2022-09-01-preview/search.json#L825
    :warning: SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Search/preview/2022-09-01-preview/search.json#L899
    ️️✔️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.

    ️️✔️~[Staging] SwaggerAPIView 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.
    ️️✔️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?

    openapi-pipeline-app[bot] avatar Dec 14 '22 23:12 openapi-pipeline-app[bot]

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    openapi-pipeline-app[bot] avatar Dec 14 '22 23:12 openapi-pipeline-app[bot]

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

    openapi-pipeline-app[bot] avatar Dec 14 '22 23:12 openapi-pipeline-app[bot]

    Please review this PR by Igor for all previous comments and suggestions. https://github.com/Azure/azure-rest-api-specs/pull/20245

    rishikaparashar avatar Dec 15 '22 22:12 rishikaparashar

    depends on the scale of the changes, you may need schedule a review https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/271/Azure-REST-API-Stewardship

    weidongxu-microsoft avatar Dec 16 '22 02:12 weidongxu-microsoft

    @weidongxu-microsoft it was reviewed. Please refer https://github.com/Azure/azure-rest-api-specs/pull/20245 for notes and recommendations from the API review board.

    rishikaparashar avatar Dec 21 '22 00:12 rishikaparashar

    This PR is based on #20245. It only changes one of the parameters from 'location' to 'coordinate' in /search/polygon and it looks good.

    approved in https://github.com/Azure/azure-rest-api-specs/pull/20245 by Mark and Mike.

    We should be able to merge this without further approval. Ping me or assignee when ready.

    weidongxu-microsoft avatar Dec 26 '22 02:12 weidongxu-microsoft