[Azure Maps] Geolocation: swagger improvement for SDK generation [Hub…

… Generated] (Azure#16030) * Geolocation: Use user-friendly key and filename for x-ms-examples * Geolocation: Use client name ipAddress for parameter ip * Common: Set TextFormat/ResponseFormat default to json * All: Remove operationId prefix for swagger except Creator * Geolocation: Rename method GetIPToLocationPreview to GetLocation * All: Rename [Service]ApiVersion to ApiVersion * Common: Use client name mapsClientId for x-ms-client-id * Remove -Preview suffix * Common: Remove x-ms-parameterized-host/schemes/cosumes * Common: TextFormat->ResponseFormat, ResponseFormat->JsonFormat * Common: Model GeojsonObject as a closed enum * Common: Reset JsonFormat/ResponseFormat modelAsString=true * Common: Rename mapsClientId as clientId
Hardell · Sep 27, 2021 · 0fe4385 · 0fe4385
1 parent 99e632d
commit 0fe4385
Show file tree

Hide file tree

Showing 20 changed files with 266 additions and 274 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
@@ -4,18 +4,6 @@
     "title": "Azure Maps Common Types",
     "version": "1.0"
   },
-  "x-ms-parameterized-host": {
-    "hostTemplate": "{geography}.atlas.microsoft.com",
-    "parameters": [
-      {
-        "$ref": "#/parameters/GeographicResourceLocation"
-      }
-    ]
-  },
-  "schemes": [
-    "https"
-  ],
-  "consumes": [],
   "produces": [
     "application/json"
   ],
@@ -203,7 +191,7 @@
           ],
           "x-ms-enum": {
             "name": "GeoJsonObjectType",
-            "modelAsString": true,
+            "modelAsString": false,
             "values": [
               {
                 "value": "Point",
@@ -535,6 +523,7 @@
   "parameters": {
     "ClientId": {
       "name": "x-ms-client-id",
+      "x-ms-client-name": "clientId",
       "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model.  It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management  plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.",
       "type": "string",
       "in": "header",
@@ -547,7 +536,7 @@
       "type": "string",
       "x-ms-parameter-location": "method"
     },
-    "ResponseFormat": {
+    "JsonFormat": {
       "name": "format",
       "description": "Desired format of the response. Only `json` format is supported.",
       "type": "string",
@@ -557,7 +546,7 @@
         "json"
       ],
       "x-ms-enum": {
-        "name": "ResponseFormat",
+        "name": "JsonFormat",
         "modelAsString": true,
         "values": [
           {
@@ -566,9 +555,10 @@
           }
         ]
       },
+      "x-ms-client-default": "json",
       "x-ms-parameter-location": "method"
     },
-    "TextFormat": {
+    "ResponseFormat": {
       "name": "format",
       "description": "Desired format of the response. Value can be either _json_ or _xml_.",
       "type": "string",
@@ -579,7 +569,7 @@
         "xml"
       ],
       "x-ms-enum": {
-        "name": "TextFormat",
+        "name": "ResponseFormat",
         "modelAsString": true,
         "values": [
           {
@@ -592,6 +582,7 @@
           }
         ]
       },
+      "x-ms-client-default": "json",
       "x-ms-parameter-location": "method"
     },
     "GeographicResourceLocation": {

diff --git a/specification/maps/data-plane/Creator/preview/1.0/spatial.json b/specification/maps/data-plane/Creator/preview/1.0/spatial.json
@@ -49,7 +49,7 @@
   ],
   "responses": {},
   "parameters": {
-    "SpatialApiVersion": {
+    "ApiVersion": {
       "name": "api-version",
       "description": "Version number of Azure Maps API.",
       "type": "string",
@@ -176,10 +176,10 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/SpatialApiVersion"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
-            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
           },
           {
             "name": "deviceId",
@@ -263,10 +263,10 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/SpatialApiVersion"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
-            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
           },
           {
             "name": "deviceId",
@@ -348,10 +348,10 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/SpatialApiVersion"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
-            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
           },
           {
             "name": "bufferRequestBody",
@@ -388,10 +388,10 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/SpatialApiVersion"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
-            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
           },
           {
             "$ref": "#/parameters/SpatialUploadUdid"
@@ -431,10 +431,10 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/SpatialApiVersion"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
-            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
           },
           {
             "$ref": "#/parameters/SpatialLatitude"
@@ -477,10 +477,10 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/SpatialApiVersion"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
-            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
           },
           {
             "$ref": "#/parameters/SpatialUploadUdid"
@@ -525,10 +525,10 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/SpatialApiVersion"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
-            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
           },
           {
             "$ref": "#/parameters/SpatialLatitude"
@@ -565,10 +565,10 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/SpatialApiVersion"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
-            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
           },
           {
             "$ref": "#/parameters/SpatialUploadUdid"
@@ -607,10 +607,10 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/SpatialApiVersion"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
-            "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat"
           },
           {
             "name": "query",

diff --git a/specification/maps/data-plane/Creator/preview/2.0/alias.json b/specification/maps/data-plane/Creator/preview/2.0/alias.json
@@ -49,7 +49,7 @@
   ],
   "responses": {},
   "parameters": {
-    "AliasApiVersionV2": {
+    "ApiVersion": {
       "name": "api-version",
       "description": "Version number of Azure Maps API.",
       "type": "string",
@@ -97,7 +97,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/AliasApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/CreateCreatorDataItemId"
@@ -134,7 +134,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/AliasApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           }
         ],
         "x-ms-pageable": {
@@ -171,7 +171,7 @@
             "$ref": "#/parameters/AliasId"
           },
           {
-            "$ref": "#/parameters/AliasApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/AssignCreatorDataItemId"
@@ -205,7 +205,7 @@
             "$ref": "#/parameters/AliasId"
           },
           {
-            "$ref": "#/parameters/AliasApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           }
         ],
         "responses": {
@@ -233,7 +233,7 @@
             "$ref": "#/parameters/AliasId"
           },
           {
-            "$ref": "#/parameters/AliasApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           }
         ],
         "responses": {

diff --git a/specification/maps/data-plane/Creator/preview/2.0/data.json b/specification/maps/data-plane/Creator/preview/2.0/data.json
@@ -49,7 +49,7 @@
   ],
   "responses": {},
   "parameters": {
-    "DataApiVersionV2": {
+    "ApiVersion": {
       "name": "api-version",
       "description": "Version number of Azure Maps API.",
       "type": "string",
@@ -139,7 +139,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/DataApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/UploadDataDescription"
@@ -185,7 +185,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/DataApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           }
         ],
         "responses": {
@@ -219,7 +219,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/DataApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/UniqueDataId"
@@ -270,7 +270,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/DataApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/UniqueDataId"
@@ -307,7 +307,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/DataApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/UniqueDataId"
@@ -337,7 +337,7 @@
         },
         "parameters": [
           {
-            "$ref": "#/parameters/DataApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/DataUploadOperationId"

diff --git a/specification/maps/data-plane/Creator/preview/2.0/dataset.json b/specification/maps/data-plane/Creator/preview/2.0/dataset.json
@@ -49,7 +49,7 @@
   ],
   "responses": {},
   "parameters": {
-    "DatasetApiVersionV2": {
+    "ApiVersion": {
       "name": "api-version",
       "description": "Version number of Azure Maps API.",
       "type": "string",
@@ -117,7 +117,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/DatasetApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/ConversionIdQuery"
@@ -154,7 +154,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/DatasetApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           }
         ],
         "x-ms-pageable": {
@@ -191,7 +191,7 @@
             "$ref": "#/parameters/DatasetId"
           },
           {
-            "$ref": "#/parameters/DatasetApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           }
         ],
         "responses": {
@@ -219,7 +219,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/DatasetApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/DatasetId"
@@ -252,7 +252,7 @@
             "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
           },
           {
-            "$ref": "#/parameters/DatasetApiVersionV2"
+            "$ref": "#/parameters/ApiVersion"
           },
           {
             "$ref": "#/parameters/DatasetOperationId"