Skip to content

[Azure Maps] Geolocation: swagger improvement for SDK generation [Hub Generated] #16030

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.

Sign up for GitHub

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

Merged
tjprescott merged 13 commits into from
Sep 16, 2021
Merged

[Azure Maps] Geolocation: swagger improvement for SDK generation [Hub Generated] #16030

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fe7a6da
Geolocation: Use user-friendly key and filename for x-ms-examples
alankashiwa Sep 14, 2021
530fdb6
Geolocation: Use client name ipAddress for parameter ip
alankashiwa Sep 13, 2021
8b6e33b
Common: Set TextFormat/ResponseFormat default to json
alankashiwa Sep 13, 2021
b2d393d
All: Remove operationId prefix for swagger except Creator
alankashiwa Sep 14, 2021
d58d4f3
Geolocation: Rename method GetIPToLocationPreview to GetLocation
alankashiwa Sep 14, 2021
6cc6b8b
All: Rename [Service]ApiVersion to ApiVersion
alankashiwa Sep 13, 2021
04cf537
Common: Use client name mapsClientId for x-ms-client-id
alankashiwa Sep 14, 2021
68075d0
Remove -Preview suffix
alankashiwa Sep 15, 2021
f99d6ea
Common: Remove x-ms-parameterized-host/schemes/cosumes
alankashiwa Sep 15, 2021
f88b0b1
Common: TextFormat->ResponseFormat, ResponseFormat->JsonFormat
alankashiwa Sep 15, 2021
eadc4f9
Common: Model GeojsonObject as a closed enum
alankashiwa Sep 15, 2021
b809b38
Common: Reset JsonFormat/ResponseFormat modelAsString=true
alankashiwa Sep 16, 2021
f484842
Common: Rename mapsClientId as clientId
alankashiwa Sep 16, 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
29 changes: 10 additions & 19 deletions specification/maps/data-plane/Common/preview/1.0/common.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
],
Expand Down Expand Up @@ -203,7 +191,7 @@
],
"x-ms-enum": {
"name": "GeoJsonObjectType",
"modelAsString": true,
"modelAsString": false,
"values": [
{
"value": "Point",
Expand Down Expand Up @@ -535,6 +523,7 @@
"parameters": {
"ClientId": {
"name": "x-ms-client-id",
"x-ms-client-name": "mapsClientId",
"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",
Expand All @@ -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",
Expand All @@ -557,18 +546,19 @@
"json"
],
"x-ms-enum": {
"name": "ResponseFormat",
"modelAsString": true,
"name": "JsonFormat",
"modelAsString": false,
"values": [
{
"value": "json",
"description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)"
}
]
},
"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",
Expand All @@ -579,8 +569,8 @@
"xml"
],
"x-ms-enum": {
"name": "TextFormat",
"modelAsString": true,
"name": "ResponseFormat",
"modelAsString": false,
"values": [
{
"value": "json",
Expand All @@ -592,6 +582,7 @@
}
]
},
"x-ms-client-default": "json",
"x-ms-parameter-location": "method"
},
"GeographicResourceLocation": {
Expand Down
38 changes: 19 additions & 19 deletions specification/maps/data-plane/Creator/preview/1.0/spatial.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
],
"responses": {},
"parameters": {
"SpatialApiVersion": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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",
Expand Down
12 changes: 6 additions & 6 deletions specification/maps/data-plane/Creator/preview/2.0/alias.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
],
"responses": {},
"parameters": {
"AliasApiVersionV2": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
Expand Down Expand Up @@ -97,7 +97,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/AliasApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/CreateCreatorDataItemId"
Expand Down Expand Up @@ -134,7 +134,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/AliasApiVersionV2"
"$ref": "#/parameters/ApiVersion"
}
],
"x-ms-pageable": {
Expand Down Expand Up @@ -171,7 +171,7 @@
"$ref": "#/parameters/AliasId"
},
{
"$ref": "#/parameters/AliasApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/AssignCreatorDataItemId"
Expand Down Expand Up @@ -205,7 +205,7 @@
"$ref": "#/parameters/AliasId"
},
{
"$ref": "#/parameters/AliasApiVersionV2"
"$ref": "#/parameters/ApiVersion"
}
],
"responses": {
Expand Down Expand Up @@ -233,7 +233,7 @@
"$ref": "#/parameters/AliasId"
},
{
"$ref": "#/parameters/AliasApiVersionV2"
"$ref": "#/parameters/ApiVersion"
}
],
"responses": {
Expand Down
14 changes: 7 additions & 7 deletions specification/maps/data-plane/Creator/preview/2.0/data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
],
"responses": {},
"parameters": {
"DataApiVersionV2": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
Expand Down Expand Up @@ -139,7 +139,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/DataApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/UploadDataDescription"
Expand Down Expand Up @@ -185,7 +185,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/DataApiVersionV2"
"$ref": "#/parameters/ApiVersion"
}
],
"responses": {
Expand Down Expand Up @@ -219,7 +219,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/DataApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/UniqueDataId"
Expand Down Expand Up @@ -270,7 +270,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/DataApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/UniqueDataId"
Expand Down Expand Up @@ -307,7 +307,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/DataApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/UniqueDataId"
Expand Down Expand Up @@ -337,7 +337,7 @@
},
"parameters": [
{
"$ref": "#/parameters/DataApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/DataUploadOperationId"
Expand Down
12 changes: 6 additions & 6 deletions specification/maps/data-plane/Creator/preview/2.0/dataset.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
],
"responses": {},
"parameters": {
"DatasetApiVersionV2": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
Expand Down Expand Up @@ -117,7 +117,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/DatasetApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/ConversionIdQuery"
Expand Down Expand Up @@ -154,7 +154,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/DatasetApiVersionV2"
"$ref": "#/parameters/ApiVersion"
}
],
"x-ms-pageable": {
Expand Down Expand Up @@ -191,7 +191,7 @@
"$ref": "#/parameters/DatasetId"
},
{
"$ref": "#/parameters/DatasetApiVersionV2"
"$ref": "#/parameters/ApiVersion"
}
],
"responses": {
Expand Down Expand Up @@ -219,7 +219,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/DatasetApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/DatasetId"
Expand Down Expand Up @@ -252,7 +252,7 @@
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/DatasetApiVersionV2"
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/DatasetOperationId"
Expand Down
Loading