Skip to content

Commit 1f24b54

Browse files
daniel-rochaDaniel Rochaalankashiwa
authored
[Hub Generated] Review request for Search to add version preview/1.0 (#16283)
* First set of changes for Search API * More changes to address review * More changes to address review * More changes to address review * Reset searchAlongRoute name * Fixed roadUse * Fixed OAV error * Minor fixes * Fixed fuzzy search errors from review * Changes in Reverse Search Address mode * More changes from the review * Checkpoint commit * Fixed floating point numbers, dataSources field * Modified boundingBox to avoid causing model validation failure * Fixed more examples * Fixed more broken examples * Fixed more examples * Fixed more examples * Prettier fixes * Re-add street and buildingNumber * Revert client body flattening, add names for x-ms-enum * Removed locale-specific URLs * More changes to address review * More changes to address review * Minor fixes * More changes from the review * Fixed floating point numbers, dataSources field * Fixed final issues for review * Modified boundingBox to avoid causing model validation failure * Prettier fixes * Revert client body flattening, add names for x-ms-enum * Reflect operationId changes in Readme.typescript * Keep operations in TypeScript to be consistent for all languages * Update sdk generation to track2 * Prettier fix * Revert "Update sdk generation to track2" This reverts commit 5ede489e84a1820c06f7c26f70bf1bc9c2a3ec86. * Remove .net sdk generation since it is not used * Added prefix to Operation Id. * Fixed couple of operationIds * Renamed PolygonResponse * Address PR comments * More changes due to PR Review * Testing new batch naming * Fixed bug in searchInsideGeometry * Testing new batch naming * Fixed batch naming that didn't work well. * Renamed searchInsideGeometryBody to geometry * Finished all PR review comments, added changes to Common and Route Co-authored-by: Daniel Rocha <daroch@microsoft.com> Co-authored-by: alankashiwa <alankashiwa@gmail.com>
1 parent 4892f7c commit 1f24b54

File tree

12 files changed

+421
-385
lines changed

12 files changed

+421
-385
lines changed

‎specification/maps/data-plane/Common/preview/1.0/common.json‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -64,40 +64,37 @@
6464
}
6565
}
6666
},
67-
"BatchRequestBody": {
67+
"BatchRequest": {
6868
"description": "This type represents the request body for the Batch service.",
69-
"x-ms-client-name": "BatchRequest",
7069
"type": "object",
7170
"properties": {
7271
"batchItems": {
73-
"$ref": "#/definitions/BatchQueries"
72+
"description": "The list of queries to process.",
73+
"type": "array",
74+
"items": {
75+
"$ref": "#/definitions/BatchRequestItem"
76+
}
7477
}
7578
}
7679
},
77-
"BatchQueries": {
78-
"description": "The list of queries to process.",
79-
"type": "array",
80-
"items": {
81-
"$ref": "#/definitions/BatchQuery"
82-
}
83-
},
84-
"BatchQuery": {
85-
"description": "Batch Query object",
80+
"BatchRequestItem": {
81+
"description": "Batch request object",
8682
"type": "object",
8783
"properties": {
8884
"query": {
89-
"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.",
85+
"description": "This parameter contains a query string used to perform an unstructured geocoding operation. The query string will be passed verbatim to the search API for processing.",
9086
"type": "string",
9187
"example": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
9288
}
9389
}
9490
},
95-
"BatchResponse": {
91+
"BatchResult": {
9692
"description": "This object is returned from a successful Batch service call. Extend with 'batchItems' property.",
9793
"type": "object",
9894
"properties": {
9995
"summary": {
100-
"description": "Summary for the batch request",
96+
"description": "Summary of the results for the batch request",
97+
"x-ms-client-name": "BatchSummary",
10198
"type": "object",
10299
"readOnly": true,
103100
"properties": {
@@ -115,7 +112,7 @@
115112
}
116113
}
117114
},
118-
"BatchItem": {
115+
"BatchResultItem": {
119116
"description": "An item returned from Batch API. Extend with 'response' property.",
120117
"type": "object",
121118
"properties": {

‎specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressReverse.json‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@
1515
"addresses": [
1616
{
1717
"address": {
18-
"buildingNumber": "31",
1918
"streetNumber": "31",
2019
"routeNumbers": [],
21-
"street": "N 2nd St",
2220
"streetName": "N 2nd St",
2321
"streetNameAndNumber": "31 N 2nd St",
2422
"countryCode": "US",

‎specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAddressReverseBatch.json‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,8 @@
104104
"addresses": [
105105
{
106106
"address": {
107-
"buildingNumber": "410",
108107
"streetNumber": "410",
109108
"routeNumbers": [],
110-
"street": "Thomas Street",
111109
"streetName": "Thomas Street",
112110
"streetNameAndNumber": "410 Thomas Street",
113111
"countryCode": "US",

‎specification/maps/data-plane/Route/preview/1.0/route.json‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -920,7 +920,7 @@
920920
"200": {
921921
"description": "Matrix request successfully processed. The response body contains all of the results.",
922922
"schema": {
923-
"$ref": "#/definitions/RouteMatrixResponse"
923+
"$ref": "#/definitions/RouteMatrixResult"
924924
}
925925
},
926926
"202": {
@@ -958,7 +958,7 @@
958958
"200": {
959959
"description": "Matrix request successfully processed. The response body contains all of the results.",
960960
"schema": {
961-
"$ref": "#/definitions/RouteMatrixResponse"
961+
"$ref": "#/definitions/RouteMatrixResult"
962962
}
963963
},
964964
"202": {
@@ -1060,7 +1060,7 @@
10601060
"200": {
10611061
"description": "Matrix request successfully processed. The response body contains all of the results.",
10621062
"schema": {
1063-
"$ref": "#/definitions/RouteMatrixResponse"
1063+
"$ref": "#/definitions/RouteMatrixResult"
10641064
}
10651065
},
10661066
"408": {
@@ -1576,7 +1576,7 @@
15761576
"200": {
15771577
"description": "OK",
15781578
"schema": {
1579-
"$ref": "#/definitions/RouteRangeResponse"
1579+
"$ref": "#/definitions/RouteRangeResult"
15801580
}
15811581
},
15821582
"default": {
@@ -1614,15 +1614,15 @@
16141614
"description": "The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query.",
16151615
"required": true,
16161616
"schema": {
1617-
"$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody"
1617+
"$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequest"
16181618
}
16191619
}
16201620
],
16211621
"responses": {
16221622
"200": {
16231623
"description": "Batch request successfully processed. The response body contains all the batch results.",
16241624
"schema": {
1625-
"$ref": "#/definitions/RouteDirectionsBatchResponse"
1625+
"$ref": "#/definitions/RouteDirectionsBatchResult"
16261626
}
16271627
},
16281628
"202": {
@@ -1660,7 +1660,7 @@
16601660
"200": {
16611661
"description": "Batch request successfully processed. The response body contains all the batch results.",
16621662
"schema": {
1663-
"$ref": "#/definitions/RouteDirectionsBatchResponse"
1663+
"$ref": "#/definitions/RouteDirectionsBatchResult"
16641664
}
16651665
},
16661666
"202": {
@@ -1697,15 +1697,15 @@
16971697
"description": "The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query.",
16981698
"required": true,
16991699
"schema": {
1700-
"$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody"
1700+
"$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequest"
17011701
}
17021702
}
17031703
],
17041704
"responses": {
17051705
"200": {
17061706
"description": "OK",
17071707
"schema": {
1708-
"$ref": "#/definitions/RouteDirectionsBatchResponse"
1708+
"$ref": "#/definitions/RouteDirectionsBatchResult"
17091709
}
17101710
},
17111711
"408": {
@@ -2440,7 +2440,7 @@
24402440
}
24412441
}
24422442
},
2443-
"RouteRangeResponse": {
2443+
"RouteRangeResult": {
24442444
"description": "This object is returned from a successful Route Reachable Range call",
24452445
"type": "object",
24462446
"properties": {
@@ -2505,7 +2505,7 @@
25052505
}
25062506
}
25072507
},
2508-
"RouteMatrixResponse": {
2508+
"RouteMatrixResult": {
25092509
"description": "This object is returned from a successful Route Matrix call. For ex, if 2 origins and 3 destinations are provided, there are going to 2 arrays with 3 elements in each. Each element's content depends on the options provided in the query.",
25102510
"type": "object",
25112511
"properties": {
@@ -2522,7 +2522,7 @@
25222522
"type": "array",
25232523
"readOnly": true,
25242524
"items": {
2525-
"$ref": "#/definitions/RouteMatrixResult"
2525+
"$ref": "#/definitions/RouteMatrix"
25262526
}
25272527
}
25282528
},
@@ -2548,7 +2548,7 @@
25482548
}
25492549
}
25502550
},
2551-
"RouteMatrixResult": {
2551+
"RouteMatrix": {
25522552
"description": "Matrix result object",
25532553
"type": "object",
25542554
"readOnly": true,
@@ -2586,12 +2586,12 @@
25862586
}
25872587
}
25882588
},
2589-
"RouteDirectionsBatchResponse": {
2589+
"RouteDirectionsBatchResult": {
25902590
"description": "This object is returned from a successful Route Directions Batch service call.",
25912591
"type": "object",
25922592
"allOf": [
25932593
{
2594-
"$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchResponse"
2594+
"$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchResult"
25952595
}
25962596
],
25972597
"properties": {
@@ -2610,7 +2610,7 @@
26102610
"type": "object",
26112611
"allOf": [
26122612
{
2613-
"$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchItem"
2613+
"$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchResultItem"
26142614
}
26152615
],
26162616
"properties": {

‎specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverse.json‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,8 @@
1414
"addresses": [
1515
{
1616
"address": {
17-
"buildingNumber": "31",
1817
"streetNumber": "31",
1918
"routeNumbers": [],
20-
"street": "N 2nd St",
2119
"streetName": "N 2nd St",
2220
"streetNameAndNumber": "31 N 2nd St",
2321
"countryCode": "US",

‎specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverseBatch.json‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,8 @@
2222
"addresses": [
2323
{
2424
"address": {
25-
"buildingNumber": "7",
2625
"streetNumber": "7",
2726
"routeNumbers": [],
28-
"street": "Avenue Anatole France",
2927
"streetName": "Avenue Anatole France",
3028
"streetNameAndNumber": "7 Avenue Anatole France",
3129
"countryCode": "FR",
@@ -90,10 +88,8 @@
9088
"addresses": [
9189
{
9290
"address": {
93-
"buildingNumber": "410",
9491
"streetNumber": "410",
9592
"routeNumbers": [],
96-
"street": "Thomas Street",
9793
"streetName": "Thomas Street",
9894
"streetNameAndNumber": "410 Thomas Street",
9995
"countryCode": "US",

‎specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverseCrossStreet.json‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@
2626
"country": "United States",
2727
"countryCodeISO3": "USA",
2828
"freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113",
29-
"countrySubdivisionName": "California",
30-
"street": "North 2nd Street"
29+
"countrySubdivisionName": "California"
3130
},
3231
"position": "37.33666,-121.88951"
3332
}

‎specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressReverseBatch.json‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,8 @@
3535
"addresses": [
3636
{
3737
"address": {
38-
"buildingNumber": "7",
3938
"streetNumber": "7",
4039
"routeNumbers": [],
41-
"street": "Avenue Anatole France",
4240
"streetName": "Avenue Anatole France",
4341
"streetNameAndNumber": "7 Avenue Anatole France",
4442
"countryCode": "FR",
@@ -103,10 +101,8 @@
103101
"addresses": [
104102
{
105103
"address": {
106-
"buildingNumber": "410",
107104
"streetNumber": "410",
108105
"routeNumbers": [],
109-
"street": "Thomas Street",
110106
"streetName": "Thomas Street",
111107
"streetNameAndNumber": "410 Thomas Street",
112108
"countryCode": "US",

‎specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressReverseBatchSync.json‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,8 @@
3535
"addresses": [
3636
{
3737
"address": {
38-
"buildingNumber": "7",
3938
"streetNumber": "7",
4039
"routeNumbers": [],
41-
"street": "Avenue Anatole France",
4240
"streetName": "Avenue Anatole France",
4341
"streetNameAndNumber": "7 Avenue Anatole France",
4442
"countryCode": "FR",
@@ -103,10 +101,8 @@
103101
"addresses": [
104102
{
105103
"address": {
106-
"buildingNumber": "410",
107104
"streetNumber": "410",
108105
"routeNumbers": [],
109-
"street": "Thomas Street",
110106
"streetName": "Thomas Street",
111107
"streetNameAndNumber": "410 Thomas Street",
112108
"countryCode": "US",

0 commit comments

Comments
 (0)