[Maps][Search V2] add query to geocoding api by chcmsft · Pull Request #17207 · Azure/azure-rest-api-specs

chcmsft · 2022-01-04T07:10:13Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-01-04T07:10:15Z

Hi, @chcmsft 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. vsswagger@microsoft.com

openapi-pipeline-app · 2022-01-04T07:10:16Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️LintDiff: 1 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- data-plane/Search/readme.md tag:2.1-preview
Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- data-plane/Search/readme.md tag:default

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Search/preview/2022-02-01-preview/geocoding.json#L582

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

Validation passes for Avocado.

️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️⚠️Cross-Version Breaking Changes: 4 Warnings warning [Detail]

Compared Swaggers (Based on Oad v0.9.1)
- current:preview/2022-02-01-preview/geocoding.json compared with base:preview/2021-11-01-preview/geocoding.json

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

Rule	Message
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'CountryRegionSet' removed or renamed? New: Search/preview/2022-02-01-preview/geocoding.json#L44:3 Old: Search/preview/2021-11-01-preview/geocoding.json#L44:3
⚠️ 1027 - DefaultValueChanged	The new version has a different default value than the previous one. New: Search/preview/2022-02-01-preview/geocoding.json#L134:9 Old: Search/preview/2021-11-01-preview/geocoding.json#L140:9
⚠️ 1027 - DefaultValueChanged	The new version has a different default value than the previous one. New: Search/preview/2022-02-01-preview/geocoding.json#L275:9 Old: Search/preview/2021-11-01-preview/geocoding.json#L265:9
⚠️ 1027 - DefaultValueChanged	The new version has a different default value than the previous one. New: Search/preview/2022-02-01-preview/geocoding.json#L45:5 Old: Search/preview/2021-11-01-preview/geocoding.json#L45:5

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

There is no credential detected.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

maps/data-plane/Search/readme.md#2.1-preview

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

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

openapi-workflow-bot · 2022-01-04T07:10:16Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2022-01-04T07:10:16Z

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

openapi-workflow-bot · 2022-01-04T07:12:15Z

Hi @chcmsft, 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.

openapi-workflow-bot · 2022-01-04T07:17:24Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

openapi-workflow-bot · 2022-01-04T07:17:24Z

Hi @chcmsft, 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.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

weidongxu-microsoft · 2022-01-20T05:15:23Z

+          {
+            "name": "query",
+            "in": "query",
+            "description": "A string that contains information about a location, such as an address or landmark name.",
+            "required": false,
+            "type": "string"
+          },


So this API is intended to be used in 2 modes. One is providing unstructured query. Another is providing structured addressLine, adminDistrict, postalCode, etc.?

yes, exactly.

johanste · 2022-01-20T21:40:14Z

+        },
+        "parameters": [
+          {
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"


While it doesn't change the REST API, we want to move the client id to one of the last entries in the array. Tools sometimes do (and autorest in particular does) use the order of parameters to construct methods when they generate code, and we want the less often used optional parameters to be last.

good suggestion. moved.

johanste · 2022-01-20T21:43:25Z

+              "$ref": "#/definitions/GeocodingBatchResponse"
+            }
+          },
+          "206": {


206 is only applicable to range requests. If partial success is possible, we generally use status code 207 Multi-Status even though it is technically a WebDav code.

Thanks for pointing out this mistake. But it's not in the scope this time. Would fix this in the future.

chcmsft · 2022-01-24T07:55:46Z

hi @jhendrixMSFT , it's ready for review. Please help here. Many thanks!

…rameter, query

* add a new query parameter, query, to geocoding api * update parameter description * refine description * move ClientId to end of parameters for autorest * add a description to note that batch geocoding doesn't support the parameter, query

openapi-assignment-bot Bot assigned jhendrixMSFT Jan 4, 2022

chcmsft added DoNotMerge <valid label in PR review process> use to hold merge after approval NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR labels Jan 4, 2022

openapi-pipeline-app Bot added the CI-FixRequiredOnFailure label Jan 4, 2022

chcmsft force-pushed the dev-maps-Microsoft.Maps-2022-01-01 branch from da11f9e to 9da47d9 Compare January 4, 2022 07:15

openapi-pipeline-app Bot added BreakingChangeReviewRequired labels Jan 4, 2022

openapi-pipeline-app Bot removed the CI-FixRequiredOnFailure label Jan 4, 2022

chcmsft force-pushed the dev-maps-Microsoft.Maps-2022-01-01 branch from 9da47d9 to c496f96 Compare January 4, 2022 07:24

openapi-pipeline-app Bot removed the NewApiVersionRequired label Jan 4, 2022

chcmsft force-pushed the dev-maps-Microsoft.Maps-2022-01-01 branch from c496f96 to f3d6d2c Compare January 4, 2022 07:32

openapi-pipeline-app Bot added CI-FixRequiredOnFailure and removed BreakingChangeReviewRequired labels Jan 4, 2022

chcmsft force-pushed the dev-maps-Microsoft.Maps-2022-01-01 branch from f3d6d2c to efc39a3 Compare January 4, 2022 07:48

openapi-pipeline-app Bot removed the CI-FixRequiredOnFailure label Jan 4, 2022

chcmsft force-pushed the dev-maps-Microsoft.Maps-2022-01-01 branch 2 times, most recently from 3c55dbe to 601dacb Compare January 4, 2022 08:19

openapi-pipeline-app Bot added the CI-FixRequiredOnFailure label Jan 4, 2022

chcmsft force-pushed the dev-maps-Microsoft.Maps-2022-01-01 branch from 601dacb to bdf5070 Compare January 4, 2022 08:26

add a new query parameter, query, to geocoding api

494faaf

chcmsft force-pushed the dev-maps-Microsoft.Maps-2022-01-01 branch from bdf5070 to 494faaf Compare January 4, 2022 08:47

openapi-pipeline-app Bot removed the CI-FixRequiredOnFailure label Jan 4, 2022

update parameter description

044c295

czubair mentioned this pull request Jan 14, 2022

[Azure Maps Search] REST API Review for Azure Maps Search #17350

Closed

czubair linked an issue Jan 14, 2022 that may be closed by this pull request

[Azure Maps Search] REST API Review for Azure Maps Search #17350

Closed

refine description

641febd

chcmsft force-pushed the dev-maps-Microsoft.Maps-2022-01-01 branch from 6970933 to 641febd Compare January 14, 2022 09:30

weidongxu-microsoft reviewed Jan 20, 2022

View reviewed changes

johanste reviewed Jan 20, 2022

View reviewed changes

move ClientId to end of parameters for autorest

502b3fb

chcmsft removed DoNotMerge <valid label in PR review process> use to hold merge after approval NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR labels Jan 24, 2022

add a description to note that batch geocoding doesn't support the pa…

e9622d7

…rameter, query

jhendrixMSFT approved these changes Jan 24, 2022

View reviewed changes

jhendrixMSFT merged commit 1e7fa59 into Azure:main Jan 24, 2022

Conversation

chcmsft commented Jan 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot Bot commented Jan 4, 2022

Uh oh!

openapi-pipeline-app Bot commented Jan 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-workflow-bot Bot commented Jan 4, 2022

Uh oh!

openapi-pipeline-app Bot commented Jan 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openapi-workflow-bot Bot commented Jan 4, 2022

Uh oh!

openapi-workflow-bot Bot commented Jan 4, 2022

Uh oh!

openapi-workflow-bot Bot commented Jan 4, 2022

Uh oh!

weidongxu-microsoft Jan 20, 2022

Choose a reason for hiding this comment

Uh oh!

chcmsft Jan 20, 2022

Choose a reason for hiding this comment

Uh oh!

johanste Jan 20, 2022

Choose a reason for hiding this comment

Uh oh!

chcmsft Jan 24, 2022

Choose a reason for hiding this comment

Uh oh!

johanste Jan 20, 2022

Choose a reason for hiding this comment

Uh oh!

chcmsft Jan 24, 2022

Choose a reason for hiding this comment

Uh oh!

chcmsft commented Jan 24, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chcmsft commented Jan 4, 2022 •

edited

Loading

openapi-pipeline-app Bot commented Jan 4, 2022 •

edited

Loading

openapi-pipeline-app Bot commented Jan 4, 2022 •

edited

Loading