[Azure Maps] Restore operationId for documentation #16742

alankashiwa · 2021-11-11T04:03:59Z

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

Changelog

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

What's the purpose of the update?
- Restore operationId for documentation consistency
- Fix a few naming issues, an enum, and a required attribute
When are you targeting to deploy the new service/feature to public regions? Services are already in production
When do you expect to publish the swagger? ASAP
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published. No data-plane SDKs are onboarded yet, so no refresh is 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?

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)

openapi-workflow-bot · 2021-11-11T04:04:02Z

Hi, @alankashiwa 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-11-11T04:04:02Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.9.1)
- 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/2.1/render.json compared with base:preview/2.1/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/weather.json compared with base:preview/1.0/weather.json

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

Rule	Message
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetDataForPoints' to 'Elevation_GetDataForPoints'. This will impact generated code. New: DEM/preview/1.0/elevation.json#L57:7 Old: DEM/preview/1.0/elevation.json#L57:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'PostDataForPoints' to 'Elevation_PostDataForPoints'. This will impact generated code. New: DEM/preview/1.0/elevation.json#L102:7 Old: DEM/preview/1.0/elevation.json#L102:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetDataForPolyline' to 'Elevation_GetDataForPolyline'. This will impact generated code. New: DEM/preview/1.0/elevation.json#L145:7 Old: DEM/preview/1.0/elevation.json#L145:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'PostDataForPolyline' to 'Elevation_PostDataForPolyline'. This will impact generated code. New: DEM/preview/1.0/elevation.json#L198:7 Old: DEM/preview/1.0/elevation.json#L198:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetDataForBoundingBox' to 'Elevation_GetDataForBoundingBox'. This will impact generated code. New: DEM/preview/1.0/elevation.json#L249:7 Old: DEM/preview/1.0/elevation.json#L249:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetLocation' to 'Geolocation_GetIPToLocation'. This will impact generated code. New: Geolocation/preview/1.0/geolocation.json#L57:7 Old: Geolocation/preview/1.0/geolocation.json#L57:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapStaticImage' to 'Render_GetMapImage'. This will impact generated code. New: Render/preview/1.0/render.json#L166:7 Old: Render/preview/1.0/render.json#L166:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapTile' to 'Render_GetMapTile'. This will impact generated code. New: Render/preview/1.0/render.json#L344:7 Old: Render/preview/1.0/render.json#L343:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapStateTile' to 'Render_GetMapStateTile'. This will impact generated code. New: Render/preview/1.0/render.json#L475:7 Old: Render/preview/1.0/render.json#L474:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetCopyrightCaption' to 'Render_GetCopyrightCaption'. This will impact generated code. New: Render/preview/1.0/render.json#L533:7 Old: Render/preview/1.0/render.json#L532:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapImageryTile' to 'Render_GetMapImageryTile'. This will impact generated code. New: Render/preview/1.0/render.json#L566:7 Old: Render/preview/1.0/render.json#L565:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetCopyrightFromBoundingBox' to 'Render_GetCopyrightFromBoundingBox'. This will impact generated code. New: Render/preview/1.0/render.json#L642:7 Old: Render/preview/1.0/render.json#L641:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetCopyrightForTile' to 'Render_GetCopyrightForTile'. This will impact generated code. New: Render/preview/1.0/render.json#L684:7 Old: Render/preview/1.0/render.json#L683:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetCopyrightForWorld' to 'Render_GetCopyrightForWorld'. This will impact generated code. New: Render/preview/1.0/render.json#L729:7 Old: Render/preview/1.0/render.json#L728:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapTileV2' to 'RenderV2_GetMapTile'. This will impact generated code. New: Render/preview/2.0/render.json#L193:7 Old: Render/preview/2.0/render.json#L193:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapTileV2' to 'RenderV2_GetMapTile'. This will impact generated code. New: Render/preview/2.1/render.json#L57:7 Old: Render/preview/2.1/render.json#L57:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapTileset' to 'RenderV2_GetMapTileset'. This will impact generated code. New: Render/preview/2.1/render.json#L129:7 Old: Render/preview/2.1/render.json#L128:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapAttribution' to 'RenderV2_GetMapAttribution'. This will impact generated code. New: Render/preview/2.1/render.json#L165:7 Old: Render/preview/2.1/render.json#L164:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapStateTile' to 'RenderV2_GetMapStateTile'. This will impact generated code. New: Render/preview/2.1/render.json#L222:7 Old: Render/preview/2.1/render.json#L221:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetCopyrightCaption' to 'RenderV2_GetCopyrightCaption'. This will impact generated code. New: Render/preview/2.1/render.json#L278:7 Old: Render/preview/2.1/render.json#L277:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetMapStaticImage' to 'RenderV2_GetMapStaticImage'. This will impact generated code. New: Render/preview/2.1/render.json#L311:7 Old: Render/preview/2.1/render.json#L310:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetCopyrightFromBoundingBox' to 'RenderV2_GetCopyrightFromBoundingBox'. This will impact generated code. New: Render/preview/2.1/render.json#L488:7 Old: Render/preview/2.1/render.json#L487:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetCopyrightForTile' to 'RenderV2_GetCopyrightForTile'. This will impact generated code. New: Render/preview/2.1/render.json#L530:7 Old: Render/preview/2.1/render.json#L529:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetCopyrightForWorld' to 'RenderV2_GetCopyrightForWorld'. This will impact generated code. New: Render/preview/2.1/render.json#L575:7 Old: Render/preview/2.1/render.json#L574:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'RequestRouteMatrix' to 'Route_PostRouteMatrix'. This will impact generated code. New: Route/preview/1.0/route.json#L830:7 Old: Route/preview/1.0/route.json#L830:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetRouteMatrix' to 'Route_GetRouteMatrix'. This will impact generated code. New: Route/preview/1.0/route.json#L935:7 Old: Route/preview/1.0/route.json#L934:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'RequestRouteMatrixSync' to 'Route_PostRouteMatrixSync'. This will impact generated code. New: Route/preview/1.0/route.json#L975:7 Old: Route/preview/1.0/route.json#L974:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetRouteDirections' to 'Route_GetRouteDirections'. This will impact generated code. New: Route/preview/1.0/route.json#L1078:7 Old: Route/preview/1.0/route.json#L1076:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetRouteDirectionsWithAdditionalParameters' to 'Route_PostRouteDirections'. This will impact generated code. New: Route/preview/1.0/route.json#L1249:7 Old: Route/preview/1.0/route.json#L1247:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetRouteRange' to 'Route_GetRouteRange'. This will impact generated code. New: Route/preview/1.0/route.json#L1432:7 Old: Route/preview/1.0/route.json#L1429:7

️⚠️LintDiff: 14 Warnings warning [Detail]

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

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ElevationModel'. Consider using the plural form of 'Elevation' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DEM/preview/1.0/elevation.json#L60
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ElevationModel'. Consider using the plural form of 'Elevation' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DEM/preview/1.0/elevation.json#L105
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ElevationModel'. Consider using the plural form of 'Elevation' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DEM/preview/1.0/elevation.json#L148
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ElevationModel'. Consider using the plural form of 'Elevation' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DEM/preview/1.0/elevation.json#L201
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ElevationModel'. Consider using the plural form of 'Elevation' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DEM/preview/1.0/elevation.json#L252
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RouteModel'. Consider using the plural form of 'Route' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L832
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RouteModel'. Consider using the plural form of 'Route' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L937
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RouteModel'. Consider using the plural form of 'Route' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L977
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RouteModel'. Consider using the plural form of 'Route' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1080
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RouteModel'. Consider using the plural form of 'Route' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1251
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RouteModel'. Consider using the plural form of 'Route' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1434
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RouteModel'. Consider using the plural form of 'Route' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1594
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RouteModel'. Consider using the plural form of 'Route' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1642
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RouteModel'. Consider using the plural form of 'Route' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1682

️️✔️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 succeeded [Detail] [Expand]

There are no breaking changes.

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

️️✔️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 · 2021-11-11T04:04:03Z

[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-11-11T04:04:03Z

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

️✔️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-weather - first release

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

⚠️Warning [Logs]Release - Generate from fabcb3e. 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-py2.py3-none-any.whl
- azure-maps-elevation-1.0rc0.zip
```
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.zip
- azure_maps_render-2.1rc0-py2.py3-none-any.whl
```
info	[Changelog] data-plan skip changelog generation temporarily
```
️✔️track2_azure-maps-route [View full logs] [Release SDK Changes]
- azure-maps-route-1.0rc0.zip
- azure_maps_route-1.0rc0-py2.py3-none-any.whl
```
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-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 fabcb3e. 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-11-12 05:23:13 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 fabcb3e. SDK Automation 14.0.0

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

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/Timezone/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.Timezone [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-11-11T04:06:59Z

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

specification/maps/data-plane/Search/preview/1.0/search.json

alankashiwa · 2021-11-11T08:04:37Z

@tjprescott I opened this PR for restoring the operationIds as discussed previously for our documentation.
In addition to the operationIds, several issues will be fixed in this PR:

[Weather] IconCode enum fix: some values are missing / there are repeated names
[Search] Method rename: GetPolygon -> ListPolygons
[Search] countryCode should be a required parameter of the SearchStructuredAddress API

Let me know if there are any concerns in this PR :)
Thanks!

tjprescott

Some questions, but otherwise looks fine to me.

tjprescott · 2021-11-11T17:46:16Z

specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json

@@ -56,7 +56,8 @@
    "/geolocation/ip/{format}": {
      "get": {
        "description": "\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis service will return the ISO country code for the provided IP address. Developers can use this information  to block or alter certain content based on geographical locations where the application is being viewed from.",
-        "operationId": "GetLocation",
+        "operationId": "Geolocation_GetIPToLocation",
+        "x-ms-client-name": "GetLocation",


To verify, changing the operation ID like this would relocate these operations from the Client to a GeolocationOperations object. Does this x-ms-client-name preserve that?

I would expect this would generate GeolocationOperations.get_location. Is that correct?

@tjprescott Yes, this "x-ms-client-name": "GetLocation" will still preserve the GeolocationOperations object so the method signature matches what you expect.

I've also tried passing --inspector options to the autorest, and found that it is the code model generated by the modelerfour that preserves the operationGroup.

thanks @alankashiwa

@tjprescott if there aren't any more concerns, can we please get this one merged? We'd like to start working on convenience layer next week. thanks!

specification/maps/data-plane/Weather/preview/1.0/weather.json

kairu-ms · 2022-01-07T02:53:08Z

specification/maps/data-plane/Render/preview/1.0/render.json

@@ -165,7 +165,8 @@
    "/map/static/{format}": {
      "get": {
        "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following S0 and S1 capabilities. \n\nIn S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn S1 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n<br><br>\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n<br><br>\n\n  |Zoom Level | Max Lon Range   | Max Lat Range|\n  |:----------|:----------------|:-------------|\n  |0          | 360.0           | 170.0        | \n  |1          | 360.0           | 170.0        |\n  |2          | 360.0           | 170.0        |\n  |3          | 360.0           | 170.0        |\n  |4          | 360.0           | 170.0        |\n  |5          | 180.0           | 85.0         |\n  |6          | 90.0            | 42.5         |\n  |7          | 45.0            | 21.25        |\n  |8          | 22.5            | 10.625       |\n  |9          | 11.25           | 5.3125       |\n  |10         | 5.625           | 2.62625      |\n  |11         | 2.8125          | 1.328125     |\n  |12         | 1.40625         | 0.6640625    |\n  |13         | 0.703125        | 0.33203125   |\n  |14         | 0.3515625       | 0.166015625  |\n  |15         | 0.17578125      | 0.0830078125 |  \n  |16         | 0.087890625     | 0.0415039063 | \n  |17         | 0.0439453125    | 0.0207519531 |\n  |18         | 0.0219726563    | 0.0103759766 |\n  |19         | 0.0109863281    | 0.0051879883 |\n  |20         | 0.0054931641    | 0.0025939941 |",
-        "operationId": "GetMapStaticImage",
+        "operationId": "Render_GetMapImage",
+        "x-ms-client_name": "GetMapStaticImage",


@tjprescott "x-ms-client_name" is an invalid name, you should use "x-ms-client-name" instead.

@alankashiwa

@kairu-ms @tjprescott Thanks for pointing this out. I've opened a PR to fix the typo: #17290

* Fix Weather IconCode enum * Restore operationId prefixes: first pass * Align the operationIds with Swaggers under Microsoft.Map * Rename GetPolygon method * Fix countryCode required attribute

alankashiwa added 3 commits November 11, 2021 11:49

Fix Weather IconCode enum

5c02e98

Restore operationId prefixes: first pass

796a6f2

Align the operationIds with Swaggers under Microsoft.Map

336b45e

alankashiwa changed the title ~~[Hub Generated] Review request for Search to add version preview/1.0~~ [Azure Maps] Restore operationId for documentation Nov 11, 2021

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Nov 11, 2021

alankashiwa requested review from daniel-rocha and alextts627 November 11, 2021 05:48

alextts627 reviewed Nov 11, 2021

View reviewed changes

specification/maps/data-plane/Search/preview/1.0/search.json Outdated Show resolved Hide resolved

alankashiwa added 2 commits November 11, 2021 15:42

Rename GetPolygon method

6990e8a

Fix countryCode required attribute

16c28f3

alankashiwa self-assigned this Nov 11, 2021

alankashiwa requested a review from tjprescott November 11, 2021 07:47

alankashiwa marked this pull request as ready for review November 11, 2021 07:53

alextts627 approved these changes Nov 11, 2021

View reviewed changes

daniel-rocha approved these changes Nov 11, 2021

View reviewed changes

tjprescott reviewed Nov 11, 2021

View reviewed changes

tjprescott added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 11, 2021

alankashiwa requested a review from tjprescott November 12, 2021 01:23

tjprescott approved these changes Nov 12, 2021

View reviewed changes

tjprescott merged commit fabcb3e into Azure:main Nov 12, 2021

alankashiwa deleted the maps-operationId-restore branch December 21, 2021 07:54

kairu-ms reviewed Jan 7, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Azure Maps] Restore operationId for documentation #16742

[Azure Maps] Restore operationId for documentation #16742

alankashiwa commented Nov 11, 2021 •

edited

Loading

openapi-workflow-bot bot commented Nov 11, 2021

openapi-pipeline-app bot commented Nov 11, 2021 •

edited

Loading

openapi-workflow-bot bot commented Nov 11, 2021

openapi-pipeline-app bot commented Nov 11, 2021 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Nov 11, 2021

alankashiwa commented Nov 11, 2021

tjprescott left a comment

tjprescott Nov 11, 2021

alankashiwa Nov 12, 2021

daniel-rocha Nov 12, 2021

kairu-ms Jan 7, 2022

tjprescott Jan 7, 2022

alankashiwa Jan 10, 2022

[Azure Maps] Restore operationId for documentation #16742

[Azure Maps] Restore operationId for documentation #16742

Conversation

alankashiwa commented Nov 11, 2021 • edited Loading

Changelog

Contribution checklist:

Breaking Change Review Checklist

openapi-workflow-bot bot commented Nov 11, 2021

openapi-pipeline-app bot commented Nov 11, 2021 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Nov 11, 2021

openapi-pipeline-app bot commented Nov 11, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Nov 11, 2021

alankashiwa commented Nov 11, 2021

tjprescott left a comment

Choose a reason for hiding this comment

tjprescott Nov 11, 2021

Choose a reason for hiding this comment

alankashiwa Nov 12, 2021

Choose a reason for hiding this comment

daniel-rocha Nov 12, 2021

Choose a reason for hiding this comment

kairu-ms Jan 7, 2022

Choose a reason for hiding this comment

tjprescott Jan 7, 2022

Choose a reason for hiding this comment

alankashiwa Jan 10, 2022

Choose a reason for hiding this comment

alankashiwa commented Nov 11, 2021 •

edited

Loading

openapi-pipeline-app bot commented Nov 11, 2021 •

edited

Loading

openapi-pipeline-app bot commented Nov 11, 2021 •

edited

Loading