Skip to content

Commit 7fab18a

Browse files
authored
[Maps Search] Update names based on APIView feedback for Preview 1.0 (#16735)
* Update names * Update names, Type by feedback
1 parent 796f5e5 commit 7fab18a

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@
118118
"properties": {
119119
"statusCode": {
120120
"description": "HTTP request status code.",
121-
"type": "number",
121+
"type": "integer",
122122
"readOnly": true,
123123
"example": 200
124124
}

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@
155155
},
156156
"SearchIndexSet": {
157157
"name": "idxSet",
158+
"x-ms-client-name": "indexFilter",
158159
"in": "query",
159160
"description": "A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)",
160161
"type": "array",
@@ -1400,6 +1401,7 @@
14001401
},
14011402
{
14021403
"name": "searchFuzzyBatchRequestBody",
1404+
"x-ms-client-name": "batchRequest",
14031405
"in": "body",
14041406
"description": "The list of search fuzzy queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.",
14051407
"required": true,
@@ -1450,6 +1452,7 @@
14501452
},
14511453
{
14521454
"name": "searchFuzzyBatchRequestBody",
1455+
"x-ms-client-name": "batchRequest",
14531456
"in": "body",
14541457
"description": "The list of search fuzzy queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.",
14551458
"required": true,
@@ -1533,6 +1536,7 @@
15331536
},
15341537
{
15351538
"name": "searchAddressBatchRequestBody",
1539+
"x-ms-client-name": "batchRequest",
15361540
"in": "body",
15371541
"description": "The list of address geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.",
15381542
"required": true,
@@ -1583,6 +1587,7 @@
15831587
},
15841588
{
15851589
"name": "searchAddressBatchRequestBody",
1590+
"x-ms-client-name": "batchRequest",
15861591
"in": "body",
15871592
"description": "The list of address geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.",
15881593
"required": true,
@@ -1666,6 +1671,7 @@
16661671
},
16671672
{
16681673
"name": "searchAddressReverseBatchRequestBody",
1674+
"x-ms-client-name": "batchRequest",
16691675
"in": "body",
16701676
"description": "The list of reverse geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.",
16711677
"required": true,
@@ -1716,6 +1722,7 @@
17161722
},
17171723
{
17181724
"name": "searchAddressReverseBatchRequestBody",
1725+
"x-ms-client-name": "batchRequest",
17191726
"in": "body",
17201727
"description": "The list of reverse geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.",
17211728
"required": true,
@@ -1803,11 +1810,6 @@
18031810
"type": "string",
18041811
"readOnly": true
18051812
},
1806-
"error": {
1807-
"description": "Reason for the failure to obtain data for this provider.",
1808-
"type": "string",
1809-
"readOnly": true
1810-
},
18111813
"geometryData": {
18121814
"description": "Geometry data in GeoJSON format. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details. Present only if \"error\" is not present.",
18131815
"$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonObject"
@@ -1963,7 +1965,7 @@
19631965
"$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated"
19641966
},
19651967
"viewport": {
1966-
"$ref": "#/definitions/Viewport"
1968+
"$ref": "#/definitions/BoundingBox"
19671969
},
19681970
"entryPoints": {
19691971
"description": "Array of EntryPoints. Those describe the types of entrances available at the location. The type can be \"main\" for main entrances such as a front door, or a lobby, and \"minor\", for side and back doors.",
@@ -2577,6 +2579,7 @@
25772579
]
25782580
},
25792581
"DataSources": {
2582+
"x-ms-client-name": "DataSource",
25802583
"description": "Optional section. Reference ids for use with the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API.",
25812584
"type": "object",
25822585
"readOnly": true,
@@ -2587,6 +2590,7 @@
25872590
}
25882591
},
25892592
"Geometry": {
2593+
"x-ms-client-name": "GeometryIdentifier",
25902594
"description": "Information about the geometric shape of the result. Only present if type == Geography.",
25912595
"type": "object",
25922596
"properties": {
@@ -2598,6 +2602,7 @@
25982602
}
25992603
},
26002604
"SearchAddressBatchProcessResult": {
2605+
"x-ms-client-name": "SearchAddressBatchResult",
26012606
"description": "This object is returned from a successful Search Address Batch service call.",
26022607
"type": "object",
26032608
"allOf": [

0 commit comments

Comments
 (0)