[Maps Search] Update names based on APIView feedback for Preview 1.0 (A…

…zure#16735) * Update names * Update names, Type by feedback
LeiWang3 · Mar 31, 2022 · 43422a9 · 43422a9
1 parent c0200af
commit 43422a9
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/specification/maps/data-plane/Common/preview/1.0/common.json b/specification/maps/data-plane/Common/preview/1.0/common.json
@@ -118,7 +118,7 @@
       "properties": {
         "statusCode": {
           "description": "HTTP request status code.",
-          "type": "number",
+          "type": "integer",
           "readOnly": true,
           "example": 200
         }

diff --git a/specification/maps/data-plane/Search/preview/1.0/search.json b/specification/maps/data-plane/Search/preview/1.0/search.json
@@ -155,6 +155,7 @@
     },
     "SearchIndexSet": {
       "name": "idxSet",
+      "x-ms-client-name": "indexFilter",
       "in": "query",
       "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)",
       "type": "array",
@@ -1400,6 +1401,7 @@
           },
           {
             "name": "searchFuzzyBatchRequestBody",
+            "x-ms-client-name": "batchRequest",
             "in": "body",
             "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.",
             "required": true,
@@ -1450,6 +1452,7 @@
           },
           {
             "name": "searchFuzzyBatchRequestBody",
+            "x-ms-client-name": "batchRequest",
             "in": "body",
             "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.",
             "required": true,
@@ -1533,6 +1536,7 @@
           },
           {
             "name": "searchAddressBatchRequestBody",
+            "x-ms-client-name": "batchRequest",
             "in": "body",
             "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.",
             "required": true,
@@ -1583,6 +1587,7 @@
           },
           {
             "name": "searchAddressBatchRequestBody",
+            "x-ms-client-name": "batchRequest",
             "in": "body",
             "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.",
             "required": true,
@@ -1666,6 +1671,7 @@
           },
           {
             "name": "searchAddressReverseBatchRequestBody",
+            "x-ms-client-name": "batchRequest",
             "in": "body",
             "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.",
             "required": true,
@@ -1716,6 +1722,7 @@
           },
           {
             "name": "searchAddressReverseBatchRequestBody",
+            "x-ms-client-name": "batchRequest",
             "in": "body",
             "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.",
             "required": true,
@@ -1803,11 +1810,6 @@
           "type": "string",
           "readOnly": true
         },
-        "error": {
-          "description": "Reason for the failure to obtain data for this provider.",
-          "type": "string",
-          "readOnly": true
-        },
         "geometryData": {
           "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.",
           "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonObject"
@@ -1963,7 +1965,7 @@
           "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPairAbbreviated"
         },
         "viewport": {
-          "$ref": "#/definitions/Viewport"
+          "$ref": "#/definitions/BoundingBox"
         },
         "entryPoints": {
           "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 @@
       ]
     },
     "DataSources": {
+      "x-ms-client-name": "DataSource",
       "description": "Optional section. Reference ids for use with the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API.",
       "type": "object",
       "readOnly": true,
@@ -2587,6 +2590,7 @@
       }
     },
     "Geometry": {
+      "x-ms-client-name": "GeometryIdentifier",
       "description": "Information about the geometric shape of the result. Only present if type == Geography.",
       "type": "object",
       "properties": {
@@ -2598,6 +2602,7 @@
       }
     },
     "SearchAddressBatchProcessResult": {
+      "x-ms-client-name": "SearchAddressBatchResult",
       "description": "This object is returned from a successful Search Address Batch service call.",
       "type": "object",
       "allOf": [