-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Azure Maps] Geolocation: swagger improvement for SDK generation [Hub Generated] #16030
[Azure Maps] Geolocation: swagger improvement for SDK generation [Hub Generated] #16030
Conversation
Hi, @alankashiwa Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
[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. |
Swagger Validation Report
|
Rule | Message |
---|---|
1002 - ProtocolNoLongerSupported |
The new version does not support 'Https' as a protocol. Old: Common/preview/1.0/common.json#L15:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'TextFormat' removed or renamed? New: Common/preview/1.0/common.json#L523:3 Old: Common/preview/1.0/common.json#L535:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'SpatialApiVersion' removed or renamed? New: Creator/preview/1.0/spatial.json#L51:3 Old: Creator/preview/1.0/spatial.json#L51:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ResponseFormat' removed or renamed? New: Creator/preview/1.0/spatial.json#L51:3 Old: Creator/preview/1.0/spatial.json#L51:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ElevationApiVersion' removed or renamed? New: DEM/preview/1.0/elevation.json#L44:3 Old: DEM/preview/1.0/elevation.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ResponseFormat' removed or renamed? New: DEM/preview/1.0/elevation.json#L44:3 Old: DEM/preview/1.0/elevation.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'GeolocationApiVersion' removed or renamed? New: Geolocation/preview/1.0/geolocation.json#L44:3 Old: Geolocation/preview/1.0/geolocation.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ResponseFormat' removed or renamed? New: Geolocation/preview/1.0/geolocation.json#L44:3 Old: Geolocation/preview/1.0/geolocation.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'RenderApiVersion' removed or renamed? New: Render/preview/1.0/render.json#L44:3 Old: Render/preview/1.0/render.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'TextFormat' removed or renamed? New: Render/preview/1.0/render.json#L44:3 Old: Render/preview/1.0/render.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'RenderApiVersionV2' removed or renamed? New: Render/preview/2.0/render.json#L44:3 Old: Render/preview/2.0/render.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'RenderApiVersionV2' removed or renamed? New: Render/preview/2.1/render.json#L44:3 Old: Render/preview/2.1/render.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'RouteApiVersion' removed or renamed? New: Route/preview/1.0/route.json#L44:3 Old: Route/preview/1.0/route.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'TextFormat' removed or renamed? New: Route/preview/1.0/route.json#L44:3 Old: Route/preview/1.0/route.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'SearchApiVersion' removed or renamed? New: Search/preview/1.0/search.json#L44:3 Old: Search/preview/1.0/search.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'TextFormat' removed or renamed? New: Search/preview/1.0/search.json#L44:3 Old: Search/preview/1.0/search.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'TimezoneApiVersion' removed or renamed? New: Timezone/preview/1.0/timezone.json#L44:3 Old: Timezone/preview/1.0/timezone.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ResponseFormat' removed or renamed? New: Timezone/preview/1.0/timezone.json#L44:3 Old: Timezone/preview/1.0/timezone.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'TrafficApiVersion' removed or renamed? New: Traffic/preview/1.0/traffic.json#L44:3 Old: Traffic/preview/1.0/traffic.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'TextFormat' removed or renamed? New: Traffic/preview/1.0/traffic.json#L44:3 Old: Traffic/preview/1.0/traffic.json#L44:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ResponseFormat' removed or renamed? New: Weather/preview/1.0/weather.json#L43:3 Old: Weather/preview/1.0/weather.json#L43:3 |
1008 - ModifiedOperationId |
The operation id has been changed from 'Elevation_GetDataForPoints' to '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 'Elevation_PostDataForPoints' to '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 'Elevation_GetDataForPolyline' to '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 'Elevation_PostDataForPolyline' to '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 'Elevation_GetDataForBoundingBox' to '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 'Geolocation_GetIPToLocationPreview' to 'GetLocation'. 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 'Render_GetMapStaticImage' to 'GetMapStaticImage'. This will impact generated code. New: Render/preview/1.0/render.json#L165:7 Old: Render/preview/1.0/render.json#L165:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'Render_GetMapTile' to 'GetMapTile'. This will impact generated code. New: Render/preview/1.0/render.json#L331:7 Old: Render/preview/1.0/render.json#L331:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'Render_GetMapStateTilePreview' to 'GetMapStateTile'. This will impact generated code. New: Render/preview/1.0/render.json#L483:7 Old: Render/preview/1.0/render.json#L483:7 |
Rule | Message |
---|---|
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'AliasApiVersionV2' removed or renamed? New: Creator/preview/2.0/alias.json#L51:3 Old: Creator/preview/2.0/alias.json#L51:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'DataApiVersionV2' removed or renamed? New: Creator/preview/2.0/alias.json#L51:3 Old: Creator/preview/2.0/alias.json#L51:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'DatasetApiVersionV2' removed or renamed? New: Creator/preview/2.0/alias.json#L51:3 Old: Creator/preview/2.0/alias.json#L51:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ConversionApiVersionV2' removed or renamed? New: Creator/preview/2.0/alias.json#L51:3 Old: Creator/preview/2.0/alias.json#L51:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'FeaturestateApiVersionV2' removed or renamed? New: Creator/preview/2.0/alias.json#L51:3 Old: Creator/preview/2.0/alias.json#L51:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'TilesetApiVersionV2' removed or renamed? New: Creator/preview/2.0/alias.json#L51:3 Old: Creator/preview/2.0/alias.json#L51:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'WFSApiVersionV2' removed or renamed? New: Creator/preview/2.0/alias.json#L51:3 Old: Creator/preview/2.0/alias.json#L51:3 |
️⚠️
LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- maps/data-plane/readme.md tag:default
- data-plane/Creator/readme.md tag:2.0-preview
- data-plane/DEM/readme.md tag:1.0-preview
- data-plane/Geolocation/readme.md tag:1.0-preview
- data-plane/Render/readme.md tag:2.1-preview
- data-plane/Render/readme.md tag:2.0-preview
- data-plane/Route/readme.md tag:1.0-preview
- data-plane/Search/readme.md tag:1.0-preview
- data-plane/Timezone/readme.md tag:1.0-preview
- data-plane/Traffic/readme.md tag:1.0-preview
- data-plane/Weather/readme.md tag:1.0-preview
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- maps/data-plane/readme.md tag:default
- data-plane/Creator/readme.md tag:2.0-preview
- data-plane/DEM/readme.md tag:1.0-preview
- data-plane/Geolocation/readme.md tag:1.0-preview
- data-plane/Render/readme.md tag:2.1-preview
- data-plane/Render/readme.md tag:2.0-preview
- data-plane/Route/readme.md tag:1.0-preview
- data-plane/Search/readme.md tag:1.0-preview
- data-plane/Timezone/readme.md tag:1.0-preview
- data-plane/Traffic/readme.md tag:1.0-preview
- data-plane/Weather/readme.md tag:1.0-preview
Rule | Message |
---|---|
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Feedback/preview/1.0/feedback.json#L216 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Mobility/preview/1.0/mobility.json#L1464 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Mobility/preview/1.0/mobility.json#L1491 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Route/preview/1.0/route.json#L1813 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Route/preview/1.0/route.json#L1855 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Route/preview/1.0/route.json#L1878 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Route/preview/1.0/route.json#L1969 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Search/preview/1.0/search.json#L2075 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Spatial/preview/1.0/spatial.json#L1095 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Spatial/preview/1.0/spatial.json#L1118 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Spatial/preview/1.0/spatial.json#L1148 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Spatial/preview/1.0/spatial.json#L1175 |
The operation 'Dataset_Create' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Dataset/preview/2.0/dataset.json#L196 |
|
The operation 'Conversion_Convert' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: DwgConversion/preview/2.0/dwgconversion.json#L203 |
|
The operation 'Tileset_Create' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Tileset/preview/2.0/tileset.json#L216 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: type Location: FeatureState/preview/2.0/featurestate.json#L827 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: type Location: Search/preview/1.0/search.json#L3448 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: geometryType Location: WFS/preview/2.0/wfs.json#L887 |
|
200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'FeatureState_PutStateset', Response code: '200' Location: Creator/preview/2.0/featurestate.json#L226 |
|
200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'FeatureState_UpdateStates', Response code: '200' Location: Creator/preview/2.0/featurestate.json#L327 |
|
200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'FeatureState_PutStateset', Response code: '200' Location: FeatureState/preview/2.0/featurestate.json#L325 |
|
200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'FeatureState_UpdateStates', Response code: '200' Location: FeatureState/preview/2.0/featurestate.json#L465 |
️️✔️
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
- maps/data-plane/Creator/readme.md#2.0-preview
- maps/data-plane/DEM/readme.md#1.0-preview
- maps/data-plane/Geolocation/readme.md#1.0-preview
- maps/data-plane/Render/readme.md#2.1-preview
- maps/data-plane/Render/readme.md#2.0-preview
- maps/data-plane/Route/readme.md#1.0-preview
- maps/data-plane/Search/readme.md#1.0-preview
- maps/data-plane/Timezone/readme.md#1.0-preview
- maps/data-plane/Traffic/readme.md#1.0-preview
- maps/data-plane/Weather/readme.md#1.0-preview
️️✔️
[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).
Swagger Generation Artifacts
|
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. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks great. Two enums I would recommend you keep modelAsString true and one rename.
@tjprescott I've made the corresponding changes. If you are okay with those, we are ready to merge :) |
… Generated] (Azure#16030) * Geolocation: Use user-friendly key and filename for x-ms-examples * Geolocation: Use client name ipAddress for parameter ip * Common: Set TextFormat/ResponseFormat default to json * All: Remove operationId prefix for swagger except Creator * Geolocation: Rename method GetIPToLocationPreview to GetLocation * All: Rename [Service]ApiVersion to ApiVersion * Common: Use client name mapsClientId for x-ms-client-id * Remove -Preview suffix * Common: Remove x-ms-parameterized-host/schemes/cosumes * Common: TextFormat->ResponseFormat, ResponseFormat->JsonFormat * Common: Model GeojsonObject as a closed enum * Common: Reset JsonFormat/ResponseFormat modelAsString=true * Common: Rename mapsClientId as clientId
… Generated] (Azure#16030) * Geolocation: Use user-friendly key and filename for x-ms-examples * Geolocation: Use client name ipAddress for parameter ip * Common: Set TextFormat/ResponseFormat default to json * All: Remove operationId prefix for swagger except Creator * Geolocation: Rename method GetIPToLocationPreview to GetLocation * All: Rename [Service]ApiVersion to ApiVersion * Common: Use client name mapsClientId for x-ms-client-id * Remove -Preview suffix * Common: Remove x-ms-parameterized-host/schemes/cosumes * Common: TextFormat->ResponseFormat, ResponseFormat->JsonFormat * Common: Model GeojsonObject as a closed enum * Common: Reset JsonFormat/ResponseFormat modelAsString=true * Common: Rename mapsClientId as clientId
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:
Contribution checklist:
If any further questions about AME onboarding or validation tools, please view the FAQ.
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.
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.