[Azure Maps] Swagger improvement for Elevation + other minor fixes [Hub Generated] #16162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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. vsswagger@microsoft.com |
|
[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 |
|---|---|
|
The new version is missing a client parameter that was found in the old version. Was 'WeatherApiVersion' removed or renamed? New: Weather/preview/1.0/weather.json#L43:3 Old: Weather/preview/1.0/weather.json#L43:3 |
|
The new version is missing a client parameter that was found in the old version. Was 'WeatherLanguage' removed or renamed? New: Weather/preview/1.0/weather.json#L43:3 Old: Weather/preview/1.0/weather.json#L43:3 |
|
The required parameter 'pointsRequestBody' was removed in the new version. Old: DEM/preview/1.0/elevation.json#L121:11 |
|
The required parameter 'linesRequestBody' was removed in the new version. Old: DEM/preview/1.0/elevation.json#L217:11 |
|
The required parameter 'points' was added in the new version. New: DEM/preview/1.0/elevation.json#L121:11 |
|
The required parameter 'polyline' was added in the new version. New: DEM/preview/1.0/elevation.json#L217:11 |
|
The new version has a different format than the previous one. New: DEM/preview/1.0/elevation.json#L277:13 Old: DEM/preview/1.0/elevation.json#L274:13 |
|
The new version has a different array collection format than the previous one. New: DEM/preview/1.0/elevation.json#L268:11 Old: DEM/preview/1.0/elevation.json#L268:11 |
| The new version has a different type 'number' than the previous one 'string'. New: DEM/preview/1.0/elevation.json#L277:13 Old: DEM/preview/1.0/elevation.json#L274:13 |
|
| The new version has a different 'allOf' property than the previous one. New: Search/preview/1.0/search.json#L1834:9 Old: Search/preview/1.0/search.json#L1848:9 |
️⚠️LintDiff: 0 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 )
| Rule | Message |
|---|---|
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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: 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
️️✔️[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
|
alankashiwa
changed the title
|
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. |
This was referenced Sep 25, 2021
This reverts commit 2ace329bd9a2442f5b7efb9e25da5e9d7d00bef2.
alankashiwa
force-pushed
the
dev-maps-DEM-1.0
branch
from
2158380
to
03231a7
Compare
|
@tjprescott I've reverted the flattening, used the enum definition for |
tjprescott
approved these changes
Oct 6, 2021
This was referenced Oct 6, 2021
Closed
Closed
jovannikolov-msft
pushed a commit
to jovannikolov-msft/azure-rest-api-specs
that referenced
this pull request
Dec 1, 2021
…ub Generated] (Azure#16162) * Add blockchain to latest profile * Add additional types * All: Rename CoordinatePair* to LatLongPair* * Elevation: Assign more descriptive name for point/line request body * Elevation: Modify descriptions for rows and columns parameters * Elevation: Use collectionFormat for parameter bounds * Elevation: Add x-ms-client-flatten to data prop (X: reverted later) * Elevation: Condense to a single result type for all the methods * Geolocation: flatten countryRegion prop * Common: add client name for View parameter * Search/Weather: Clean up referneces and apiversion * Elevation: Delete flatten since it's impossible to move array into object * Elevation: user-friendly key names for x-ms-examples * Elevation: rename the request body directly instead of using x-ms-client-name * Elevation: Remove language specific reference * Common: Remove language specific reference * Geolocation: Remove language specific reference * Elevation: rename data property and its type * Elevation: rename 'endpointsOfPolyline' to simply 'polyline' * Revert "Geolocation: flatten countryRegion prop" This reverts commit 2ace329bd9a2442f5b7efb9e25da5e9d7d00bef2. * Common: Change View's type to enum and modify its client name Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
…ub Generated] (Azure#16162) * Add blockchain to latest profile * Add additional types * All: Rename CoordinatePair* to LatLongPair* * Elevation: Assign more descriptive name for point/line request body * Elevation: Modify descriptions for rows and columns parameters * Elevation: Use collectionFormat for parameter bounds * Elevation: Add x-ms-client-flatten to data prop (X: reverted later) * Elevation: Condense to a single result type for all the methods * Geolocation: flatten countryRegion prop * Common: add client name for View parameter * Search/Weather: Clean up referneces and apiversion * Elevation: Delete flatten since it's impossible to move array into object * Elevation: user-friendly key names for x-ms-examples * Elevation: rename the request body directly instead of using x-ms-client-name * Elevation: Remove language specific reference * Common: Remove language specific reference * Geolocation: Remove language specific reference * Elevation: rename data property and its type * Elevation: rename 'endpointsOfPolyline' to simply 'polyline' * Revert "Geolocation: flatten countryRegion prop" This reverts commit 2ace329bd9a2442f5b7efb9e25da5e9d7d00bef2. * Common: Change View's type to enum and modify its client name Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.