[Hub Generated] fix host parametrization in all non-Creator Maps Clients #15386

ambientlight · 2021-07-27T10:43:07Z

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

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- All Maps clients had x-ms-parameterized-host applied, while only Maps - Creator clients needs such parametrization arising from data sovereignty requirement, as creator stores and manages customer data. This fixes redundant parametrization for non-creator swagger specs.
When you are targeting to deploy new service/feature to public regions? Services are already deployed.
When you expect to publish swagger? ASAP
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
No data-plane SDKs are onboarded yet, so no refresh required.

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.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in 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:
Submitted new intake: https://msazure.visualstudio.com/One/_workitems/edit/10450031

openapi-workflow-bot · 2021-07-27T10:43:09Z

Hi, @ambientlight 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 · 2021-07-27T10:43:09Z

Swagger Validation Report

️❌BreakingChange: 9 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.9.0)
- current:preview/1.0/elevation.json compared with base:preview/1.0/elevation.json
- current:preview/1.0/geolocation.json compared with base:preview/1.0/geolocation.json
- current:preview/1.0/render.json compared with base:preview/1.0/render.json
- current:preview/2.0/render.json compared with base:preview/2.0/render.json
- current:preview/1.0/route.json compared with base:preview/1.0/route.json
- current:preview/1.0/search.json compared with base:preview/1.0/search.json
- current:preview/1.0/timezone.json compared with base:preview/1.0/timezone.json
- current:preview/1.0/traffic.json compared with base:preview/1.0/traffic.json
- current:preview/1.0/weather.json compared with base:preview/1.0/weather.json

Rule	Message
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'GeographicResourceLocation' removed or renamed? New: DEM/preview/1.0/elevation.json#L44:3 Old: DEM/preview/1.0/elevation.json#L51:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'GeographicResourceLocation' removed or renamed? New: Geolocation/preview/1.0/geolocation.json#L44:3 Old: Geolocation/preview/1.0/geolocation.json#L51:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'GeographicResourceLocation' removed or renamed? New: Render/preview/1.0/render.json#L44:3 Old: Render/preview/1.0/render.json#L51:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'GeographicResourceLocation' removed or renamed? New: Render/preview/2.0/render.json#L44:3 Old: Render/preview/2.0/render.json#L51:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'GeographicResourceLocation' removed or renamed? New: Route/preview/1.0/route.json#L44:3 Old: Route/preview/1.0/route.json#L51:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'GeographicResourceLocation' removed or renamed? New: Search/preview/1.0/search.json#L44:3 Old: Search/preview/1.0/search.json#L51:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'GeographicResourceLocation' removed or renamed? New: Timezone/preview/1.0/timezone.json#L44:3 Old: Timezone/preview/1.0/timezone.json#L51:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'GeographicResourceLocation' removed or renamed? New: Traffic/preview/1.0/traffic.json#L44:3 Old: Traffic/preview/1.0/traffic.json#L51:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'GeographicResourceLocation' removed or renamed? New: Weather/preview/1.0/weather.json#L43:3 Old: Weather/preview/1.0/weather.json#L50:3

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

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.9 )
Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.9 )

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

Validation passes for Avocado.

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/DEM/readme.md",
"tag":"1.0-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/DEM/readme.md",
"tag":"1.0-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

The following errors/warnings exist before current PR submission:

|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/DEM/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Geolocation/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Geolocation/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Render/readme.md",
"tag":"2.0-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Render/readme.md",
"tag":"2.0-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Route/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Route/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Search/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Search/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Timezone/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Timezone/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Traffic/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Traffic/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Weather/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"maps/data-plane/Weather/readme.md",
"tag":"1.0-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

openapi-workflow-bot · 2021-07-27T10:43:09Z

[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 · 2021-07-27T10:43:09Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-python-track2 - track2_azure-maps-elevation - first release
️✔️azure-sdk-for-python-track2 - track2_azure-maps-geolocation - first release
️✔️azure-sdk-for-python-track2 - track2_azure-maps-render - first release
️✔️azure-sdk-for-python-track2 - track2_azure-maps-route - first release
️✔️azure-sdk-for-python-track2 - track2_azure-maps-search - first release
️✔️azure-sdk-for-python-track2 - track2_azure-maps-timezone - first release
️✔️azure-sdk-for-python-track2 - track2_azure-maps-traffic - first release
️✔️azure-sdk-for-python-track2 - track2_azure-maps-weather - first release

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from d23e3e2. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️track2_azure-maps-elevation [View full logs] [Release SDK Changes]
- azure-maps-elevation-1.0rc0.zip
- azure_maps_elevation-1.0rc0-py2.py3-none-any.whl
```
info	[Changelog] data-plan skip changelog generation temporarily
```
️✔️track2_azure-maps-geolocation [View full logs] [Release SDK Changes]
- azure_maps_geolocation-1.0rc0-py2.py3-none-any.whl
- azure-maps-geolocation-1.0rc0.zip
```
info	[Changelog] data-plan skip changelog generation temporarily
```
️✔️track2_azure-maps-render [View full logs] [Release SDK Changes]
- azure_maps_render-2.1rc0-py2.py3-none-any.whl
- azure-maps-render-2.1rc0.zip
```
info	[Changelog] data-plan skip changelog generation temporarily
```
️✔️track2_azure-maps-route [View full logs] [Release SDK Changes]
- azure_maps_route-1.0rc0-py2.py3-none-any.whl
- azure-maps-route-1.0rc0.zip
```
info	[Changelog] data-plan skip changelog generation temporarily
```
️✔️track2_azure-maps-search [View full logs] [Release SDK Changes]
- azure_maps_search-1.0rc0-py2.py3-none-any.whl
- azure-maps-search-1.0rc0.zip
```
info	[Changelog] data-plan skip changelog generation temporarily
```
️✔️track2_azure-maps-timezone [View full logs] [Release SDK Changes]
- azure-maps-timezone-1.0rc0.zip
- azure_maps_timezone-1.0rc0-py2.py3-none-any.whl
```
info	[Changelog] data-plan skip changelog generation temporarily
```
️✔️track2_azure-maps-traffic [View full logs] [Release SDK Changes]
- azure-maps-traffic-1.0rc0.zip
- azure_maps_traffic-1.0rc0-py2.py3-none-any.whl
```
info	[Changelog] data-plan skip changelog generation temporarily
```
️✔️track2_azure-maps-weather [View full logs] [Release SDK Changes]
- azure-maps-weather-1.0rc0.zip
- azure_maps_weather-1.0rc0-py2.py3-none-any.whl
```
info	[Changelog] data-plan skip changelog generation temporarily
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from d23e3e2. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-08-24 16:16:53 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from d23e3e2. SDK Automation 14.0.0

Only show 15 items here, please refer to log for details.

cmderr	[Autorest] realpath(): Permission denied
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/Traffic/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/maps/data-plane/Weather/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Azure.Maps.Elevation [View full logs] [Release SDK Changes]
️✔️Azure.Maps.Geolocation [View full logs] [Release SDK Changes]
️✔️Azure.Maps.Render [View full logs] [Release SDK Changes]
️✔️Azure.Maps.Route [View full logs] [Release SDK Changes]
️✔️Azure.Maps.Search [View full logs] [Release SDK Changes]
️✔️Azure.Maps.Timezone [View full logs] [Release SDK Changes]
️✔️Azure.Maps.Traffic [View full logs] [Release SDK Changes]
️✔️Azure.Maps.Weather [View full logs] [Release SDK Changes]

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

openapi-workflow-bot · 2021-07-27T10:46:27Z

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

daniel-rocha · 2021-08-18T01:47:34Z

Hi @tjprescott as @ambientlight explained in the other PRs, this isn't really a breaking change, just fixing the Swagger to match what the production APIs look like. Can you please approve and merge this? It's blocking our SDK generation. Thanks!

daniel-rocha · 2021-08-19T00:33:14Z

@johanste can you do the breaking change review here too, please? Thanks!

tjprescott · 2021-08-19T20:48:51Z

@ambientlight @daniel-rocha have any SDKs been released with the previous version of the API?

ambientlight · 2021-08-19T20:56:39Z

@tjprescott: no Azure Maps REST sdks have been released yet.

tjprescott · 2021-08-20T16:21:15Z

@lmazuel can you merge this WIP? No SDKs have been released with this Swagger.

fix host parametrization for non-creator clients

a84ca58

openapi-assignment-bot bot assigned tjprescott Jul 27, 2021

ambientlight requested a review from propheel July 27, 2021 10:43

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Jul 27, 2021

ambientlight changed the title ~~[Hub Generated] Review request for Common to add version preview/1.0~~ [Hub Generated] fix host parametrization in all non-Creator Maps Clients Jul 27, 2021

ambientlight requested review from tjprescott and evaou July 27, 2021 10:56

evaou approved these changes Jul 27, 2021

View reviewed changes

ambientlight mentioned this pull request Jul 29, 2021

[Hub Generated] Review request for Render to add version preview/2.1 #15411

Merged

13 tasks

ambientlight mentioned this pull request Aug 6, 2021

[Maps] Adding Operations for airQuality (current, forecast/daily/ and forecast/hourly) to weather swagger #15249

Closed

26 tasks

tjprescott approved these changes Aug 20, 2021

View reviewed changes

johanste added FalsePositive-BreakingChange Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 labels Aug 20, 2021

tjprescott merged commit d23e3e2 into Azure:main Aug 24, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Hub Generated] fix host parametrization in all non-Creator Maps Clients #15386

[Hub Generated] fix host parametrization in all non-Creator Maps Clients #15386

ambientlight commented Jul 27, 2021 •

edited

Loading

openapi-workflow-bot bot commented Jul 27, 2021

openapi-pipeline-app bot commented Jul 27, 2021 •

edited

Loading

openapi-workflow-bot bot commented Jul 27, 2021

openapi-pipeline-app bot commented Jul 27, 2021 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 27, 2021

daniel-rocha commented Aug 18, 2021

daniel-rocha commented Aug 19, 2021

tjprescott commented Aug 19, 2021

ambientlight commented Aug 19, 2021

tjprescott commented Aug 20, 2021

[Hub Generated] fix host parametrization in all non-Creator Maps Clients #15386

[Hub Generated] fix host parametrization in all non-Creator Maps Clients #15386

Conversation

ambientlight commented Jul 27, 2021 • edited Loading

Changelog

Contribution checklist:

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jul 27, 2021

openapi-pipeline-app bot commented Jul 27, 2021 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Jul 27, 2021

openapi-pipeline-app bot commented Jul 27, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 27, 2021

daniel-rocha commented Aug 18, 2021

daniel-rocha commented Aug 19, 2021

tjprescott commented Aug 19, 2021

ambientlight commented Aug 19, 2021

tjprescott commented Aug 20, 2021

ambientlight commented Jul 27, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jul 27, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jul 27, 2021 •

edited

Loading