Skip to content

[Azure Maps] Timezone: Swagger improvement for SDK generation [Hub Generated] #16057

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
merged 20 commits into from
Oct 14, 2021
Merged

[Azure Maps] Timezone: Swagger improvement for SDK generation [Hub Generated] #16057

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
eba562e
Rename with `x-ms-client-name`
AlexTsao Sep 16, 2021
39fae76
Add extensible enum for timezone accept language
AlexTsao Sep 16, 2021
499f70e
Rename operationId to have better method meaning
AlexTsao Sep 16, 2021
0053414
Updated description for HasZone1970Location property
AlexTsao Sep 16, 2021
c41bf27
Removed Enum in model class name
AlexTsao Sep 16, 2021
a15c65b
Better naming for TimeTransitions
AlexTsao Sep 16, 2021
da6cfa9
Updated x-ms-examples to be more friendly
alextts627 Sep 17, 2021
c03e88d
Update Descriptions
alextts627 Sep 17, 2021
f8aa939
Update method name
alextts627 Sep 17, 2021
379681a
Update coordinates with collectionFormat csv
AlexTsao Sep 24, 2021
286c8a4
Modified sunrise, sunset type
AlexTsao Sep 24, 2021
d5e1f6c
Update wording for hasZone1970Location description
alextts627 Oct 6, 2021
449f8a2
Use LatLongPair as reference
alextts627 Oct 8, 2021
247802c
Modify exists definitions
alextts627 Oct 8, 2021
cc3febc
Update Examples to fix Model Validation
alextts627 Oct 10, 2021
a21f42d
Rename to Timezone to be consistent
alextts627 Oct 10, 2021
52429a1
Update description for hasZone1970Location
alextts627 Oct 10, 2021
cf4b904
Minor updates for name, type
alextts627 Oct 11, 2021
fbe7553
Modified property to uppercase to match exmaples
alextts627 Oct 12, 2021
44e7546
Changed back to using RepresentativePoint
alextts627 Oct 12, 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
4 changes: 2 additions & 2 deletions specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneByCoordinates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@
"Sunset": "2019-06-17T21:05:18.017-07:00"
},
"RepresentativePoint": {
"Latitude": 34.05222222222222,
"Longitude": -118.24277777777777
"latitude": 34.05222222222222,
"longitude": -118.24277777777777
},
"TimeTransitions": [
{
Expand Down
4 changes: 2 additions & 2 deletions specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneByID.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
"PosixTz": "<+03>-3"
},
"RepresentativePoint": {
"Latitude": 25.283333333333335,
"Longitude": 51.533333333333331
"latitude": 25.283333333333335,
"longitude": 51.533333333333331
},
"TimeTransitions": [
{
Expand Down
205 changes: 47 additions & 158 deletions specification/maps/data-plane/Timezone/preview/1.0/timezone.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@
},
"TimezoneTransitionsFrom": {
"name": "transitionsFrom",
"x-ms-client-name": "daylightSavingsTimeFrom",
"in": "query",
"description": "Alternatively, use alias \"tf\". The start date from which daylight savings time (DST) transitions are requested, only applies when \"options\" = all or \"options\" = transitions.",
"type": "string",
Expand All @@ -111,6 +112,7 @@
},
"TimezoneTransitionsYears": {
"name": "transitionsYears",
"x-ms-client-name": "daylightSavingsTimeLastingYears",
"in": "query",
"description": "Alternatively, use alias \"ty\". The number of years from \"transitionsFrom\" for which DST transitions are requested, only applies when \"options\" = all or \"options\" = transitions.",
"type": "integer",
Expand All @@ -123,7 +125,7 @@
"description": "__Time Zone by Id__\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns current, historical, and future time zone information for the specified IANA time zone ID.",
"operationId": "GetTimezoneByID",
"x-ms-examples": {
"GetTimezoneByID": {
"Successfully retrieve timezone by ID": {
"$ref": "./examples/GetTimezoneByID.json"
}
},
Expand Down Expand Up @@ -154,6 +156,7 @@
},
{
"name": "query",
"x-ms-client-name": "timezoneId",
"in": "query",
"description": "The IANA time zone ID.",
"required": true,
Expand All @@ -164,7 +167,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TimezoneByIdResult"
"$ref": "#/definitions/TimezoneResult"
}
},
"default": {
Expand All @@ -178,7 +181,7 @@
"description": "__Time Zone by Coordinates__\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.",
"operationId": "GetTimezoneByCoordinates",
"x-ms-examples": {
"GetTimezoneByCoordinates": {
"Successfully retrieve timezone by coordinates": {
"$ref": "./examples/GetTimezoneByCoordinates.json"
}
},
Expand Down Expand Up @@ -210,16 +213,24 @@
{
"name": "query",
"in": "query",
"description": "Coordinates of the point for which time zone information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".",
"description": "Coordinates of the point for which time zone information is requested. This parameter is a list of coordinates, containing a pair of coordinate(lat, long). When this endpoint is called directly, coordinates are passed in as a single string containing coordinates, separated by commas.",
"required": true,
"type": "string"
"x-ms-client-name": "coordinates",
"type": "array",
"collectionFormat": "csv",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TimezoneByCoordinatesResult"
"$ref": "#/definitions/TimezoneResult"
}
},
"default": {
Expand All @@ -230,10 +241,10 @@
},
"/timezone/enumWindows/{format}": {
"get": {
"description": "__Enumerate Windows Time Zones__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a full list of Windows Time Zone IDs.",
"operationId": "GetTimezoneEnumWindows",
"description": "__Windows Time Zones__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a full list of Windows Time Zone IDs.",
"operationId": "GetWindowsTimezoneIds",
"x-ms-examples": {
"GetTimezoneEnumWindows": {
"Successfully retrieve Windows timezone Ids": {
"$ref": "./examples/GetTimezoneEnumWindows.json"
}
},
Expand Down Expand Up @@ -263,10 +274,10 @@
},
"/timezone/enumIana/{format}": {
"get": {
"description": "__Enumerate IANA Time Zones__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a full list of IANA time zone IDs. Updates to the IANA service will be reflected in the system within one day.",
"operationId": "GetTimezoneEnumIANA",
"description": "__IANA Time Zones__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a full list of IANA time zone IDs. Updates to the IANA service will be reflected in the system within one day.",
"operationId": "GetIANATimezoneIds",
"x-ms-examples": {
"GetTimezoneEnumIANA": {
"Successfully retrieve Iana timezone Ids": {
"$ref": "./examples/GetTimezoneEnumIANA.json"
}
},
Expand Down Expand Up @@ -296,10 +307,10 @@
},
"/timezone/ianaVersion/{format}": {
"get": {
"description": "__Time Zone IANA Version__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns the current IANA version number.",
"operationId": "GetTimezoneIANAVersion",
"description": "__Time Zone IANA Version__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns the current IANA version number as Metadata.",
"operationId": "GetIANAVersion",
"x-ms-examples": {
"GetTimezoneIANAVersion": {
"Successfully retrieve Iana version metadata": {
"$ref": "./examples/GetTimezoneIANAVersion.json"
}
},
Expand Down Expand Up @@ -330,9 +341,9 @@
"/timezone/windowsToIana/{format}": {
"get": {
"description": "__Windows to IANA Time Zone__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a corresponding IANA ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.",
"operationId": "GetTimezoneWindowsToIANA",
"operationId": "ConvertWindowsTimezoneToIANA",
"x-ms-examples": {
"GetTimezoneWindowsToIANA": {
"Successfully retrieve corresponding timezone Iana": {
"$ref": "./examples/GetTimezoneWindowsToIANA.json"
}
},
Expand All @@ -349,13 +360,15 @@
{
"name": "query",
"in": "query",
"x-ms-client-name": "windowsTimezoneId",
"description": "The Windows time zone ID.",
"required": true,
"type": "string"
},
{
"name": "territory",
"in": "query",
"x-ms-client-name": "windowsTerritoryCode",
"description": "Windows Time Zone territory code.",
"type": "string"
}
Expand Down Expand Up @@ -424,28 +437,8 @@
}
}
},
"TimezoneByIdResult": {
"description": "This object is returned from a successful Timezone By ID call",
"type": "object",
"properties": {
"Version": {
"description": "Version property",
"type": "string",
"readOnly": true
},
"ReferenceUtcTimestamp": {
"description": "Reference Utc Timestamp property",
"type": "string",
"readOnly": true,
"format": "date-time"
},
"TimeZones": {
"$ref": "#/definitions/TimeZonesById"
}
}
},
"TimezoneByCoordinatesResult": {
"description": "This object is returned from a successful Timezone By Coordinates call",
"TimezoneResult": {
"description": "This object is returned from a successful Timezone By ID call or By Coordinates call",
"type": "object",
"properties": {
"Version": {
Expand All @@ -460,18 +453,18 @@
"format": "date-time"
},
"TimeZones": {
"$ref": "#/definitions/TimeZonesByCoordinates"
"$ref": "#/definitions/TimezoneIds"
}
}
},
"TimezoneEnumWindowsResult": {
"description": "This object is returned from a successful Timezone Enum Windows call",
"type": "array",
"items": {
"$ref": "#/definitions/TimezoneEnumWindow"
"$ref": "#/definitions/TimezoneWindows"
}
},
"TimezoneEnumWindow": {
"TimezoneWindows": {
"type": "object",
"properties": {
"WindowsId": {
Expand Down Expand Up @@ -538,73 +531,21 @@
"readOnly": true
},
"hasZone1970Location": {
"description": "HasZone1970Location property",
"description": "This attribute returns `True` if the IanaId has any country/zone associated with it.",
"type": "boolean",
"readOnly": true
}
}
},
"TimeZonesById": {
"description": "TimeZoneById array",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/TimezoneById"
}
},
"TimeZonesByCoordinates": {
"description": "TimeZoneByCoordinates array",
"TimezoneIds": {
"description": "TimeZoneId array",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/TimeZoneByCoordinates"
}
},
"TimezoneById": {
"type": "object",
"properties": {
"Id": {
"description": "Id property",
"type": "string",
"readOnly": true
},
"Aliases": {
"description": "An array of time zone ID aliases.  Only returned when [options]=*zoneinfo* or *all*.\n\nNote: may be null.",
"type": "array",
"readOnly": true,
"items": {
"type": "string",
"readOnly": true
}
},
"Countries": {
"description": "An array of country records. Only returned when [options]=*zoneinfo* or *all*.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/CountryRecord"
}
},
"Names": {
"$ref": "#/definitions/TimezoneNames"
},
"ReferenceTime": {
"$ref": "#/definitions/ReferenceTimeById"
},
"RepresentativePoint": {
"$ref": "#/definitions/RepresentativePoint"
},
"TimeTransitions": {
"description": "Time zone DST transitions from [transitionsFrom] until timestamp + 1 year.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/TimeTransition"
}
}
"$ref": "#/definitions/TimezoneId"
}
},
"TimeZoneByCoordinates": {
"TimezoneId": {
"type": "object",
"properties": {
"Id": {
Expand Down Expand Up @@ -633,10 +574,10 @@
"$ref": "#/definitions/TimezoneNames"
},
"ReferenceTime": {
"$ref": "#/definitions/ReferenceTimeByCoordinates"
"$ref": "#/definitions/ReferenceTime"
},
"RepresentativePoint": {
"$ref": "#/definitions/RepresentativePoint"
"$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPair"
},
"TimeTransitions": {
"description": "Time zone DST transitions from [transitionsFrom] until timestamp + 1 year.",
Expand Down Expand Up @@ -674,44 +615,7 @@
}
}
},
"ReferenceTimeById": {
"description": "Details in effect at the local time.",
"type": "object",
"readOnly": true,
"properties": {
"Tag": {
"description": "Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect).",
"type": "string",
"readOnly": true
},
"StandardOffset": {
"description": "UTC offset in effect at the `ReferenceUTCTimestamp`.",
"type": "string",
"readOnly": true
},
"DaylightSavings": {
"description": "Time saving in minutes in effect at the `ReferenceUTCTimestamp`.",
"type": "string",
"readOnly": true
},
"WallTime": {
"description": "Current wall time at the given time zone as shown in the `Tag` property.",
"type": "string",
"readOnly": true
},
"PosixTzValidYear": {
"description": "The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year.",
"type": "integer",
"readOnly": true
},
"PosixTz": {
"description": "POSIX string used to set the time zone environment variable.",
"type": "string",
"readOnly": true
}
}
},
"ReferenceTimeByCoordinates": {
"ReferenceTime": {
"description": "Details in effect at the local time.",
"type": "object",
"readOnly": true,
Expand Down Expand Up @@ -747,30 +651,15 @@
"readOnly": true
},
"Sunrise": {
"description": "Sunrise at the given time zone as shown in the `Tag` property.",
"description": "Sunrise at the given time zone as shown in the `Tag` property. The sunrise is described in the ISO8601 format. (Only be populated if the call is byCoordinates)",
"type": "string",
"format": "date-time",
"readOnly": true
},
"Sunset": {
"description": "Sunset at the given time zone as shown in the `Tag` property.",
"description": "Sunset at the given time zone as shown in the `Tag` property. The sunset is described in the ISO8601 format.(Only be populated if the call is byCoordinates)",
"type": "string",
"readOnly": true
}
}
},
"RepresentativePoint": {
"description": "Representative point property",
"type": "object",
"readOnly": true,
"properties": {
"Latitude": {
"description": "Latitude property",
"type": "number",
"readOnly": true
},
"Longitude": {
"description": "Longitude property",
"type": "number",
"format": "date-time",
"readOnly": true
}
}
Expand Down