Skip to content
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] Route: Swagger improvement for SDK generation [Hub Generated] #16193

Merged
merged 43 commits into from
Oct 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
30e360f
Route: Rename parameter/client names
alankashiwa Sep 27, 2021
71398dc
Route: Rename request body names
alankashiwa Sep 28, 2021
551a8c0
Route: Model a few objects as enum
alankashiwa Sep 28, 2021
bc8179f
Route: rename magnitudeOfDelay
alankashiwa Sep 29, 2021
4fe427d
Route: update startPointIndex/endPointIndex docstrings
alankashiwa Sep 29, 2021
1e50dbc
Route: departureTime/arrivalTime to date-time
alankashiwa Sep 29, 2021
91f16f5
Route: Fix name in typescript.md
alankashiwa Sep 29, 2021
c319497
Route: modify docstrings for firstInstructionIndex/lastInstructionIndex
alankashiwa Sep 29, 2021
d5ed197
Route: rename turnAngleInDecimalDegrees
alankashiwa Sep 30, 2021
cb28f8b
Route: Add docstrings for RouteSection/RouteLeg
alankashiwa Sep 30, 2021
504407d
Route: rename report object
alankashiwa Sep 30, 2021
ee3e952
Route: add friendly x-ms-examples key name
alankashiwa Sep 30, 2021
f4d0509
Route: rearrange definitions for better review
alankashiwa Sep 30, 2021
6a0c249
Route: remove language reference in hyperlink
alankashiwa Oct 1, 2021
a0fd8a4
Route: Remove repeated descriptions of batch API
alankashiwa Oct 1, 2021
1b0fc9f
Changed model name RouteDirectionsSummary to RouteSummary
alextts627 Sep 29, 2021
691ca98
Rename to RouteRangeResponse
alextts627 Sep 29, 2021
cab7e9c
Add max/min values for efficiency
alextts627 Oct 1, 2021
5762ad4
Name changing with x-ms-client-name
alextts627 Oct 5, 2021
8eb1997
Minor update
alextts627 Oct 6, 2021
b76aa8d
Route: naming fix
alankashiwa Oct 7, 2021
ed2f7bc
renamed all kWh to KwH
alextts627 Oct 7, 2021
484f635
Route: add default values
alankashiwa Oct 7, 2021
e76b7bd
Route: Fix wrong name
alankashiwa Oct 8, 2021
c3f2c6e
Route: Change response type name
alankashiwa Oct 8, 2021
71c0a19
Updated name and descriptions for route attributes
alextts627 Oct 8, 2021
2efc1e7
Merge pull request #3 from alankashiwa/minor_update
alankashiwa Oct 8, 2021
f491d9c
Remote language in URL
alankashiwa Oct 8, 2021
46c8328
Route: definition name changed for type name
alankashiwa Oct 8, 2021
5c77153
Route: keep the operations for maintaining SDK consistencies
alankashiwa Oct 8, 2021
26b3c42
Route: Change response object names
alankashiwa Oct 8, 2021
da1171e
Route: Fix parameter type
alankashiwa Oct 8, 2021
bbf1b82
Common: Add more definitions for better client type name
alankashiwa Oct 8, 2021
c1e0692
Common: Add description for query parameter
alankashiwa Oct 8, 2021
04e408e
Route: Just rename RouteSummary Definition
alankashiwa Oct 8, 2021
e677d79
Common: Redo the naming for batchItems
alankashiwa Oct 8, 2021
6c629a1
Route: add names for x-ms-enum
alankashiwa Oct 11, 2021
1d73e4d
Route: change all floats to doubles (verified in backend)
alankashiwa Oct 12, 2021
685ef8d
Route: use collectionFormat for route range api
alankashiwa Oct 12, 2021
164a634
Route: rename operationIds to remove Post wording
alankashiwa Oct 13, 2021
8553d53
Modified two method names
Oct 13, 2021
f6f2703
Route: update vehicleCommericial's client name
alankashiwa Oct 15, 2021
d982129
Route: update description/client name for carTrain
alankashiwa Oct 15, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions specification/maps/data-plane/Common/preview/1.0/common.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,29 @@
},
"BatchRequestBody": {
"description": "This type represents the request body for the Batch service.",
"x-ms-client-name": "BatchRequest",
"type": "object",
"properties": {
"batchItems": {
"description": "The list of queries to process.",
"type": "array",
"items": {
"description": "Batch Query object",
"type": "object",
"properties": {
"query": {
"description": "Partial query string.",
"type": "string",
"example": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
}
}
}
"$ref": "#/definitions/BatchQueries"
}
}
},
"BatchQueries": {
"description": "The list of queries to process.",
"type": "array",
"items": {
"$ref": "#/definitions/BatchQuery"
}
},
"BatchQuery": {
"description": "Batch Query object",
"type": "object",
"properties": {
"query": {
"description": "A query string for the corresponding batch API endpoint. It is the exact query string you would use for a single (non-batch) API request.",
"type": "string",
"example": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
alankashiwa marked this conversation as resolved.
Show resolved Hide resolved
}
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"format": "json",
"api-version": "1.0",
"query": "52.50931,13.42936:52.50274,13.43872",
"postRouteDirectionsRequestBody": {
"routeDirectionParameters": {
"supportingPoints": {
"type": "GeometryCollection",
"geometries": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"parameters": {
"format": "json",
"api-version": "1.0",
"postRouteDirectionsBatchRequestBody": {
"routeDirectionsBatchQueries": {
"batchItems": [
{
"query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"parameters": {
"format": "json",
"api-version": "1.0",
"postRouteDirectionsBatchRequestBody": {
"routeDirectionsBatchQueries": {
"batchItems": [
{
"query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"format": "json",
"api-version": "1.0",
"routeType": "shortest",
"postRouteMatrixRequestBody": {
"routeMatrixQuery": {
"origins": {
"type": "MultiPoint",
"coordinates": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"format": "json",
"api-version": "1.0",
"routeType": "shortest",
"postRouteMatrixRequestBody": {
"routeMatrixQuery": {
"origins": {
"type": "MultiPoint",
"coordinates": [
Expand Down
684 changes: 498 additions & 186 deletions specification/maps/data-plane/Route/preview/1.0/route.json

Large diffs are not rendered by default.

6 changes: 1 addition & 5 deletions specification/maps/data-plane/Route/readme.typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,11 @@ clear-output-folder: false
generate-metadata: false
directive:
- from: route.json
where: $.definitions.PostRouteDirectionsRequestBody.properties.supportingPoints
where: $.definitions.RouteDirectionParameters.properties.supportingPoints
transform: >
$ = {
"description": "A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route.\n - The provided sequence of supporting points is used as input for route reconstruction.\n - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations.\n - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are\n expected to be at (or very near) the beginning and end of the reference route, respectively.\n - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>.\n - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are\n ignored for the calculation of the reference route's travel time and traffic delay.",
"type": "object"
};
reason: Autorest TS codegen does not deserialize array of base class objects as an operation parameter properly -> https://github.com/Azure/autorest.typescript/issues/1040
- remove-operation: Route_GetRouteMatrix
reason: This operation is created for Java SDK that has no LRO poller implementation
- remove-operation: Route_GetRouteDirectionsBatch
reason: This operation is created for Java SDK that has no LRO poller implementation
```